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

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
    

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:

  1. tagging with version name that MUST following semver. e.g.: git tag 1.0.1
  2. build distribution files: python setup.py sdist bdist_wheel
  3. make a test release: twine upload --repository-url https://test.pypi.org/legacy dist/<new-version-files>
  4. make a release: twine upload dist/<new-version-files>
  5. check PyPI page: https://pypi.org/p/sphinxcontrib-ogp
  6. 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/.