python-sphinx

6熱

1答えて

スフィンクスで関数シグネチャを生成する方法は？

、パッケージ構造とファイルは次のように設定されています $ tree . . ├── doc │   ├── Makefile │   ├── README.md │   ├── _build │   ├── _static │   ├── conf.py │   ├── foo.rst │   ├── index.rst │   └── make.bat └── foo

python documentation python-sphinx 2016-01-17

---

9熱

1答えて

sphinx-bootstrap-themeに基づくPython-Sphinxドキュメントのサイドバーを有効にする

私はnice sphinx-bootstrap-theme 0.3.4を使用しており、Sphinx Python Documentation Generatorバージョン1.2の上にそれを適用しようとしています。 make htmlでドキュメントをビルドすると、このexampleで可能であることが示されていますが、サイドバーが表示されません。どちらも、ビルド設定ファイル（conf.py）でサイドバ

python-sphinx 2014-01-05

---

5熱

2答えて

Sphinx：autodocを含むhtmlの強制再構築

現在、sphinx-buildを実行すると、ソースファイルに変更があったときにのみ、インラインドキュメントストリングが取得されて使用されます。私は-aスイッチでsphinx-buildを呼び出そうとしましたが、これは効果がないようです。 HTML出力を完全に再構築し、強制的に自動実行を実行するにはどうすればよいですか？

python python-sphinx 2014-01-09

---

10熱

2答えて

autodocでいくつかのモジュールを無視する

私は選択されたモジュールに対してのみautodocを使用しようとしています。 .. automodule:: some.specific.module :members: ファイルが正しく生成されています。残念なことに、autodocは他のファイルも解析しようとし続けます（インポートエラーのため失敗します）。私はいくつかのモジュールを模擬することができますが、私はより良い解決策を望ん

python python-sphinx documentation-generation 2015-12-22

---

15熱

3答えて

複数行の記述は

だから、reStructuredTextのは、あなたの関数のシグネチャのドキュメントを正規化することができます find in the sphinx documentation か、Pythonのコード ドキュメントの the recommended wayです。すべての例は 単線​​ですが、パラメータ記述が次のような複数行の場合はどうですか？ ？ def f(a, b): """ Do

python coding-style python-sphinx restructuredtext docstring 2015-09-14

---

5熱

2答えて

スフィンクスのテーブルにクラスを追加しますか？

私は最初にテーブルを持っており、SphinxでHTMLにコンパイルするときにクラスを追加したいと思います。 the docsによれば、テーブルの前に.. class::ディレクティブを追加すると、クラスがテーブルに追加されるはずですが、代わりに定義リストが追加されます。 テーブルコードは次のとおりです。になり .. class:: special == == == a b c 1 2 3

python-sphinx restructuredtext 2015-11-03

---

7熱

2答えて

辞書データをSphinxドキュメントに表示

Pythonプロジェクトのソースコードで、デフォルトの設定値を説明する辞書があります。辞書はかなり長いです。私はSphinxのマニュアルを「ソースの表示」以外の形式で表示して、人々がデフォルト値を素早く確認できるようにしたいと考えています。 スフィンクスは、スフィンクスのオートドックと一緒に使用すると人間が判読できる形式の辞書に似た変数をフォーマットするオプションを提供していますか？私は現在、モジ

python python-sphinx 2015-01-10

---

8熱

2答えて

スフィンクスTOCツリーを修正してください

:maxdepth: 2を含むTOC（index.rst）を持つSphinx projectがあります。問題はreleaseセクションの深さを1に減らして、メインのTOCにリリースノートのリストがない（リストが長すぎる）ようにしたいということです。 それはTOCリ​​ストはdoctree-resolvedイベントハンドラを使用して変更することができるようですが、私は、イベントハンドラでTOCツリー

python python-sphinx 2015-11-10

---

7熱

1答えて

スフィンクスで自動的にdocクラスのToctreeを作成する

私のライブラリの1つでドキュメントを増やす予定です。私はドキュメント作成のためにsphinxを使っていましたが、最近はautodoc拡張を探っていました。 ほとんどのプロフェッショナルなドキュメントのように、各クラスのドキュメントページには、すべてのドキュメント化されたメソッドのリストがあり、上部にリンクがあります。つまり、最上位のtoctreeには、それぞれ深いメソッドのドキュメントへのハイパー

python python-sphinx autodoc 2016-01-01

---

6熱

2答えて

code-block ::にオプションの引数がない場合、Sphinxのhighlight_language設定オプションのポイントは何ですか？

code-block ::にオプションの引数がない場合、Sphinxのhighlight_language設定オプションのポイントは何ですか？ デフォルトのhightlight_languageが設定されていますが、コードを指定するたびに言語を記述する必要がある場合は、configオプションが必要なのはなぜですか？ 何か間違っていますか？ 編集：ログから、codeblockの引数を削除します。 C

python python-sphinx 2016-01-12

---