Sphinx への貢献

There are many ways you can contribute to Sphinx, be it filing bug reports or feature requests, writing new documentation or submitting patches for new or fixed behavior. This guide serves to illustrate how you can get started with this.

Getting help

The Sphinx community maintains a number of mailing lists and IRC channels.

Stack Overflow with tag python-sphinx

Questions and answers about use and development.

sphinx-users <sphinx-users@googlegroups.com>

ユーザーサポートのためのメーリングリスト

sphinx-dev <sphinx-dev@googlegroups.com>

開発関連の議論を行うためのメーリングリスト

#sphinx-doc on irc.freenode.net

開発の質問やユーザーサポートのためのIRCチャンネル

バグ報告と機能のリクエスト

If you have encountered a problem with Sphinx or have an idea for a new feature, please submit it to the issue tracker on GitHub or discuss it on the sphinx-dev mailing list.

For bug reports, please include the output produced during the build process and also the log file Sphinx creates after it encounters an unhandled exception. The location of this file should be shown towards the end of the error message.

関係するソースファイルを含めるか、リンクを提供することで、私たちが問題を解決する助けになります。可能なら、エラーを生成する最小のプロジェクトを作成して、代わりにそれを送信するようにしてください。

Writing code

The Sphinx source code is managed using Git and is hosted on GitHub. The recommended way for new contributors to submit code to Sphinx is to fork this repository and submit a pull request after committing changes to their fork. The pull request will then need to be approved by one of the core developers before it is merged into the main repository.

Getting started

Before starting on a patch, we recommend checking for open issues or open a fresh issue to start a discussion around a feature idea or a bug. If you feel uncomfortable or uncertain about an issue or your changes, feel free to email the sphinx-dev mailing list.

これらは Sphinx の開発を始めるために必要な基本的なステップです。

  1. GitHub上にアカウントを作る。

  2. GitHubインタフェースを使用して、 Sphinx のメインリポジトリ (sphinx-doc/sphinx) をフォークする。

  3. フォークしたリポジトリをあなたのマシンにクローンする。

    git clone https://github.com/USERNAME/sphinx
    cd sphinx
    
  4. 適切なブランチをチェックアウトする。

    Sphinx adopts Semantic Versioning 2.0.0 (refs: https://semver.org/ ).

    For changes that preserves backwards-compatibility of API and features, they should be included in the next MINOR release, use the A.x branch.

    git checkout A.x
    

    For incompatible or other substantial changes that should wait until the next MAJOR release, use the master branch.

    For urgent release, a new PATCH branch must be branched from the newest release tag (see Sphinx's release process for detail).

  5. Setup a virtual environment.

    This is not necessary for unit testing, thanks to tox, but it is necessary if you wish to run sphinx-build locally or run unit tests without the help of tox:

    virtualenv ~/.venv
    . ~/.venv/bin/activate
    pip install -e .
    
  6. Create a new working branch. Choose any name you like.

    git checkout -b feature-xyz
    
  7. ハック・ハック・ハック

    Write your code along with tests that shows that the bug was fixed or that the feature works as expected.

  8. Add a bullet point to CHANGES if the fix or feature is not trivial (small doc updates, typo fixes), then commit:

    git commit -m '#42: Add useful new feature that does this.'
    

    GitHub recognizes certain phrases that can be used to automatically update the issue tracker. For example:

    git commit -m 'Closes #42: Fix invalid markup in docstring of Foo.bar.'
    

    これはチケット #42 をクローズします。

  9. Push changes in the branch to your forked repository on GitHub:

    git push origin feature-xyz
    
  10. Submit a pull request from your branch to the respective branch (master or A.x).

  11. コア開発者が変更をレビューするのを待つ。

Coding style

Please follow these guidelines when writing code for Sphinx:

  • プロジェクトの他の部分で使用されているのと同じコードスタイルをなるべく使用してください。詳細は、 Pocoo Styleguide を参照してください。

  • 自明でない変更については、 CHANGES ファイルを更新してください。あなたの変更が既存の振る舞いを変更する場合は、このことをドキュメント化してください。

  • 新機能はドキュメント化されなければなりません。適切な場合は例とユースケースを含めてください。可能なら、生成される出力に表示されるサンプルを含めてください。

  • When adding a new configuration variable, be sure to document it and update sphinx/cmd/quickstart.py if it's important enough.

  • 適切なユニットテストを追加してください。

Style and type checks can be run using tox:

tox -e mypy
tox -e flake8

Unit tests

Sphinx is tested using pytest for Python code and Karma for JavaScript.

To run Python unit tests, we recommend using tox, which provides a number of targets and allows testing against multiple different Python environments:

  • To list all possible targets:

    tox -av
    
  • To run unit tests for a specific Python version, such as Python 3.6:

    tox -e py36
    
  • To run unit tests for a specific Python version and turn on deprecation warnings on so they're shown in the test output:

    PYTHONWARNINGS=all tox -e py36
    
  • Arguments to pytest can be passed via tox, e.g. in order to run a particular test:

    tox -e py36 tests/test_module.py::test_new_feature
    

You can also test by installing dependencies in your local environment:

pip install .[test]

To run JavaScript tests, use npm:

npm install
npm run test

New unit tests should be included in the tests directory where necessary:

  • バグフィックスについては、まず最初に問題を再現する、つまり失敗するテストを追加してください。その後テストが通るようにバグを修正します。

  • Tests that need a sphinx-build run should be integrated in one of the existing test modules if possible. New tests that to @with_app and then build_all for a few assertions are not good since the test suite should not take more than a minute to run.

バージョン 1.8 で追加: Sphinx also runs JavaScript tests.

バージョン 1.6 で追加: sphinx.testing is added as a experimental.

バージョン 1.5.2 で変更: Sphinx was switched from nose to pytest.

課題

The below belongs in the developer guide

Utility functions and pytest fixtures for testing are provided in sphinx.testing. If you are a developer of Sphinx extensions, you can write unit tests with using pytest. At this time, sphinx.testing will help your test implementation.

How to use pytest fixtures that are provided by sphinx.testing? You can require 'sphinx.testing.fixtures' in your test modules or conftest.py files like this:

pytest_plugins = 'sphinx.testing.fixtures'

さらに詳しい使い方を知りたい場合は、tests/conftest.py と``tests`` ディレクトリ配下にある test_*.py ファイルらを参照してください。

Writing documentation

課題

Add a more extensive documentation contribution guide.

You can build documentation using tox:

tox -e docs

翻訳

The parts of messages in Sphinx that go into builds are translated into several locales. The translations are kept as gettext .po files translated from the master template sphinx/locale/sphinx.pot.

Sphinxはメッセージを展開し、カタログファイルを管理するために Babel を使っています。これは setup.py に含まれています。

  • .pot テンプレートを更新するには python setup.py extract_messages を使います。

  • テンプレートファイルにある現時点でのメッセージで sphinx/locale/*/LC_MESSAGES のすべての既存のカタログを更新するには、 python setup.py update_catalog を使います。

  • .po ファイルをバイナリの .mo ファイルと .js ファイルにコンパイルするには python setup.py compile_catalog を使います。

更新された .po ファイルが投稿された場合、ソースとコンパイルされたカタログの両方をコミットするために compile_catalog を実行します。

When a new locale is submitted, add a new directory with the ISO 639-1 language identifier and put sphinx.po in there. Don't forget to update the possible values for language in doc/usage/configuration.rst.

The Sphinx core messages can also be translated on Transifex. There tx client tool, which is provided by the transifex_client Python package, can be used to pull translations in .po format from Transifex. To do this, go to sphinx/locale and then run tx pull -f -l LANG where LANG is an existing language identifier. It is good practice to run python setup.py update_catalog afterwards to make sure the .po file has the canonical Babel formatting.

Debugging tips

  • コードに変更を加えた場合は、コマンド make clean の実行または sphinx-build -E オプションの使用によりドキュメントをビルドする前にビルドキャッシュを削除してください。

  • Use the sphinx-build -P option to run pdb on exceptions.

  • ドキュメント構造の表示可能な表現を生成するには node.pformat()node.asdom().toxml() を使用してください。

  • 生成される出力に警告が表示されるよう、設定変数 keep_warningsTrue を設定してください。

  • 既知のターゲットのない参照について Sphinx が警告するように、設定変数 nitpickyTrue を設定してください。

  • Docutils 設定ファイル 中でデバッグオプションを設定してください。

  • JavaScript stemming algorithms in sphinx/search/*.py (except en.py) are generated by this modified snowballcode generator. Generated JSX files are in this repository. You can get the resulting JavaScript files using the following command:

    npm install
    node_modules/.bin/grunt build # -> dest/*.global.js