OGP feature for Sphinx html builder¶

This is a OGP support for Sphinx.

Support versions¶

This product is tested with:

Python-3.5, 3.6, 3.7
Sphinx-1.8 or later

License¶

Apache Software License

Contents¶

Quick Start¶

Installation¶

Please install sphinxcontrib-ogp with using pip (8.1.1 or later).

$ pip install sphinxcontrib-ogp

Sphinx conf.py¶

conf.py¶

extensions = [
    'sphinxcontrib_ogp',
]

og_site_url = 'http://sphinx-users.jp/'
og_twitter_site = '@sphinxjp'

Development¶

Contribution Guideline¶

This is a Sphinx OGP project. By contributing you agree to abide by the Contributor Code of Conduct.

Issue Reporting¶

To Be Written

https://github.com/sphinx-contrib/ogp/issues

Setup development environment¶

Requires supported Python version

do setup under sphinxcontrib-ogp.git repository root as:

$ pip install -U pip setuptools wheel setuotools_scm
$ pip install -r dev-requires.txt

Pull Request¶

To Be Written

https://github.com/sphinx-contrib/ogp/pulls

Releasing¶

New package version¶

The sphinxcontrib-ogp package will be uploaded to PyPI: https://pypi.org/project/sphinxcontrib-ogp/.

Here is a release procedure for releasing.

Prepare newest packages:

setuptools
wheel
twine

Procedure:

tagging with version name that MUST following semver. e.g.: git tag 1.0.1
build distribution files: python setup.py sdist bdist_wheel
make a test release: twine upload --repository-url https://test.pypi.org/legacy dist/<new-version-files>
make a release: twine upload dist/<new-version-files>
check PyPI page: https://pypi.org/p/sphinxcontrib-ogp
bump version in CHANGES.rst and commit/push them onto GitHub

Updated documentation¶

Sphinx documentation under doc/ directory on the master branch will be automatically uploaded into ReadTheDocs: http://sphinxcontrib-ogp.rtfd.io/.