开发

行为准则

您同意遵守 贡献者行为准则 才可以贡献。

贡献指南

报告议题

尚待撰写

• https://github.com/sphinx-doc/sphinx-intl/issues

Pull Request

尚待撰写

• https://github.com/sphinx-doc/sphinx-intl/pulls

设置开发环境

• 需要支持的 Python 版本

• 在 sphinx-intl.git 仓库根目录下进行设置，作为

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

测试

支持 Python 版本的测试，在：

• setup.py

• tox.ini

• .travis.yml

运行测试

仅运行 tox:

$ tox

tox 有几个部分可以测试。

CI（持续化集成）

所有测试都将在 Travis CI 服务上运行。

• https://travis-ci.org/sphinx-doc/sphinx-intl

发布

新的软件包版本

sphinx-intl 软件包将被上传到 PyPI：https://pypi.org/project/sphinx-intl/ 。

这里有一个释放的程序，用于发布。

程序：

1. 检查 travis-ci 测试结果。https://travis-ci.org/sphinx-doc/sphinx-intl

2. 更新 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. 用必须在 semver 之后的版本名进行标记，例如：git tag 1.0.1。

7. git push --tags to push tag

8. 在 sphinx_intl/__init__.py 和 CHANGES.rst 中提升版本，然后提交/推送到 GitHub

更新文档

主分支上 doc/ 目录下的 Sphinx 文档将自动上传到 ReadTheDocs: http://sphinx-intl.rtfd.io/。”