Code of Conduct
By contributing you agree to abide by the Contributor Code of Conduct.
To Be Written
To Be Written
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
Install Transifex CLI tool (refer to Installation instructions):
$ curl -o- https://raw.githubusercontent.com/transifex/cli/master/install.sh | bash
Tests with supported python version that are in:
Just run tox:
tox have several sections for testing.
CI (Continuous Integration)
All tests will be run on GitHub Actions.
New package version
The sphinx-intl package will be uploaded to PyPI: https://pypi.org/project/sphinx-intl/.
Here is a release procedure:
check GitHub Actions test results: https://github.com/sphinx-doc/sphinx-intl/actions
update release version/date in
python setup.py release sdist bdist_wheel
twine upload dist/<target-package-file>
check PyPI page: https://pypi.org/p/sphinx-intl
tagging with version name that MUST following semver. e.g.:
git tag 1.0.1
git push --tagsto push tag
bump version in
CHANGES.rstthen commit/push them onto GitHub
Sphinx documentation under
doc/ directory on the master branch will be automatically uploaded into ReadTheDocs: http://sphinx-intl.rtfd.io/.