Setuptools統合¶

Sphinxは、カスタムコマンドによるsetuptoolsおよびdistutilsとの統合をサポートしています- BuildDoc それがそうです。

Setuptoolsを使用した統合¶

そして、distutilsからSphinx構築をトリガすることができ、 setup.py あるいは…。 setup.cfg Sphinx自身のプロファイルではありません

例えば例えば setup.py **

# this is only necessary when not using setuptools/distribute
from sphinx.setup_command import BuildDoc
cmdclass = {'build_sphinx': BuildDoc}

name = 'My project'
version = '1.2'
release = '1.2.0'
setup(
    name=name,
    author='Bernard Montgomery',
    version=release,
    cmdclass=cmdclass,
    # these are optional and override conf.py settings
    command_options={
        'build_sphinx': {
            'project': ('setup.py', name),
            'version': ('setup.py', version),
            'release': ('setup.py', release),
            'source_dir': ('setup.py', 'doc')}},
)

注釈

もし直接いたら setup() 命令の際は，変数名中のハイフンを下線に置き換えてください.上の例では source-dir Vbl.成る source_dir それがそうです。

この部分を追加して setup.cfg **

[build_sphinx]
project = 'My project'
version = 1.2
release = 1.2.0
source-dir = 'doc'

構成が完了した後，アップグレードで関連命令を用いることでこのメソッドを呼び出す. setup.py **

$ python setup.py build_sphinx

Setuptools統合用オプション¶

fresh-env¶

生成時に保存された環境を破棄すべきか否かを判定するブール値である。デフォルトは間違っています。

これもまた -E 標識が着いた setup.py ：

$ python setup.py build_sphinx -E

all-files¶

すべてのファイルが最初から構築されるべきかどうかを決定するためのブール値。デフォルトは間違っています。

これもまた -a 標識が着いた setup.py ：

$ python setup.py build_sphinx -a

source-dir¶

ターゲットソースディレクトリ。これは setup.py あるいは…。 setup.cfg 書類、あるいはそれは絶対的であってもよい。デフォルト値は ./doc あるいは…。 ./docs もしその中の1つに名前が含まれていれば conf.py (検査) ./doc 第1)；そうでなければ、デフォルトは現在のディレクトリである。

これもまた -s 標識が着いた setup.py ：

$ python setup.py build_sphinx -s $SOURCE_DIR

build-dir¶: オブジェクト生成ディレクトリ.これは setup.py あるいは…。 setup.cfg 書類、あるいはそれは絶対的であってもよい。デフォルト値は ./build/sphinx それがそうです。

config-dir¶

ディレクトリの位置を配置する.これは setup.py あるいは…。 setup.cfg 書類、あるいはそれは絶対的であってもよい。デフォルトの場合、使用 source-dir それがそうです。

これもまた -c 標識が着いた setup.py ：

$ python setup.py build_sphinx -c $CONFIG_DIR

バージョン 1.0 で追加.

builder¶

使用する生成器または生成器リスト。デフォルト値は html それがそうです。

これもまた -b 標識が着いた setup.py ：

$ python setup.py build_sphinx -b $BUILDER

バージョン 1.6 で変更: ここで、このリストは、コンマまたはスペース区切りのビルダリストであってもよい

warning-is-error¶

Sphinx警告が構築失敗のブール値をもたらすことを確実にする。デフォルトは間違っています。

これもまた -W 標識が着いた setup.py ：

$ python setup.py build_sphinx -W

バージョン 1.5 で追加.

project¶: 記録された項目の名前。デフォルト値は '' それがそうです。

バージョン 1.0 で追加.

version¶: 短いX.Yバージョンですデフォルト値は '' それがそうです。

バージョン 1.0 で追加.

release¶: 完全版は，alpha/beta/rcラベルを含む.デフォルト値は '' それがそうです。

バージョン 1.0 で追加.

today¶: 代替のために現在の日付のフォーマットを設定する方法 |today| それがそうです。デフォルト値は '' それがそうです。

バージョン 1.0 で追加.

link-index¶

Index.htmlがメイン文書のブール値にリンクされることを確認します。デフォルトは間違っています。

これもまた -i 標識が着いた setup.py ：

$ python setup.py build_sphinx -i

バージョン 1.0 で追加.

copyright¶: 著作権文字列。デフォルト値は '' それがそうです。

バージョン 1.3 で追加.

nitpicky¶: 難癖モードで動作する。現在、これはすべての不足している参照のための警告を生成するだろう。構成値の表示 nitpick_ignore “既知の損失”と呼ばれるいくつかの参照を排除するための方法を探す。

バージョン 1.8 で追加.

pdb¶: 配置するブール値 pdb 例外的な場合。デフォルトは間違っています。

バージョン 1.5 で追加.

Table of Contents

前のトピックへ

次のトピックへ

Setuptools統合¶

Setuptoolsを使用した統合¶

Setuptools統合用オプション¶