python-sphinx

1熱

2答えて

Sphinxで構文ハイライトを無効にする方法は？私はhighlight language to 'none'とsetting ..language:: noneを設定しようとしました。 setting it to 'text'もお試しください。 htmlとmake cleanを削除しようとしました。しかし、構文の強調表示はそこにあります。（アラバスターのテーマを使用して） conf.pyは、こ

0熱

1答えて

SphinxにAnacondaインタプリタを使用するように指示する方法

AnacondaをPythonインタプリタとして使用するPythonプロジェクトを作成しました。プロジェクトはうまく動作しますが、今はSphinxを使ってそれを文書化しようとしていますが、私はCryptoライブラリが見つからないという問題に遭遇しています。 SphinxにAnaconda Pythonインタプリタを使用するよう指示する方法はありますか？依存関係をすべて見つけられるようにリストする方

2熱

2答えて

Pythonのスフィンクスは、私がこのような構造を持つプロジェクトのためにスフィンクスを持つドキュメントを生成していたパターン

を除外する。私は、ドキュメント/ conf.py exclude_patterns = ['**/workflow/definitions', 'workflow/definitions', '*workflow/definitions', 'workflow/definitions*', 'workflow/definitions/*', 'workflow/definitions/*.*']

1熱

1答えて

Sphinxでは、__getattr__で提供される文書属性

PythonのSphinxでは、__getattr__のおかげで利用可能な属性をどのように文書化できますか？私は、セクション名に一致する属性、つまりconfig_manager.<section_name>を使用して設定の任意のセクションにアクセスできるような設定マネージャのインスタンスを持っています。 .. autoclass:: ConfigManager :members:

1熱

2答えて

Sphinx - 単一のソースから内部文書と外部文書を生成する

文書の特定の部分を「内部」としてタグ付けしてsphinx-build -b -include internal source outputのように構築するSphinxの能力に関する情報を見つけることを試みています。-includeフラグには、出力に表示されます。これは、1つのソースを維持しながら、2つ以上のバージョンのドキュメントを生成することを可能にします。例： .. audience::i

0熱

1答えて

readthedocsの模擬モジュールからのパラメータを含むスフィンクスautodoc

私たちはオープンソースプロジェクトのパンダパワーを文書化するためにreadthedocsを使用しています。 pandapowerはrtdで構築できないnumpyやその他のCライブラリに依存するため、autodoc_mock_importsパラメータを使用してこれらのライブラリの模擬インポートを作成します。これは一般的にはうまくいくが、デフォルトパラメータとしてnp.nanを持つ関数（例えばhere

0熱

1答えて

sphinx rst用語集へのリンク先添え字

このようなスフィンクスの用語集は、適切な書式設定のために下付き文字を使用する代わりに使用します。 |VOH| Minimum output voltage representative of a logic 1 .. |VOH| replace:: V\ :sub:`OH`\ にはどうすれば適切に適切な添字のフォーマットでも、私のdocoumentの別の場所からこの用語を参照する

1熱

2答えて

私のPythonモジュールからsphinx-quickstart auto-includeドキュメントストリングを作る方法

私はPythonプロジェクトのドキュメントを生成するためにSphinxを試しています。私は実際にそれを動作させることができることを確かめるために、私はそれを試してみるためにテストプロジェクトを作った：https://github.com/ThomasA/sphinxtest。私はこのリポジトリのルートにsphinx-quickstartを実行しました。以下の質問では、ドキュメンテーションルートと

0熱

1答えて

文字列の定義へのリンク

私はAPIを文書化しています。 APIは、websocket接続を介して特定の形式のJSONデータを送信することから構成されます。以下に例を示します。私の質問は、 :py:func:`json.dumps` と同様にリンクすることができスフィンクス内のオブジェクト、私はクラスまたは関数の場合と同じように、これらのメッセージタイプのそれぞれを持つのいずれかの方法があるさ私のためのリンクを自動的