Development

Code of Conduct

By contributing you agree to abide by the Contributor Code of Conduct.

Contribution Guideline

Setup development environment

  • Requires supported Python version

  • do setup under sphinx-intl.git repository root as:

    $ pip install -U pip setuptools wheel setuptools_scm
$ pip install -r requirements-testing.txt

Testing

Tests with supported python version that are in:

  • setup.py
  • tox.ini
  • .travis.yml

Run test

Just run tox:

$ tox

tox have several sections for testing.

CI (Continuous Integration)

All tests will be run on Travis CI service.

Releasing

New package version

The sphinx-intl package will be uploaded to PyPI: https://pypi.org/project/sphinx-intl/.

Here is a release procefure for releasing.

Procedure:

  1. check travis-ci testing result: https://travis-ci.org/sphinx-doc/sphinx-intl
  2. update release version/date in CHANGES.rst
  3. python setup.py release sdist bdist_egg
  4. twine upload dist/<target-package-file>
  5. check PyPI page: https://pypi.org/p/sphinx-intl
  6. tagging with version name that MUST following semver. e.g.: git tag 1.0.1
  7. git push --tags to push tag
  8. bump version in sphinx_intl/__init__.py and CHANGES.rst then commit/push them onto GitHub

Updated documentation

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