restructuredtext

5熱

1答えて

私が試したすべてのレンダラーで、codeとcode-blockは全く同じ結果を示しています：コードブロック。どちらも正確に同じHTMLを生成します - クラスとタグの種類を含む（私はそれがdocutilsだと思います）： <pre class="code [language] literal-block"> どういう違いがありますか？なぜ我々は両方を持っていますか？異なるレンダリングを行うレン

5熱

2答えて

reStructuredTextにSphinxでブログスタイルタグを追加する方法

reStructuredTextで書かれ、SphinxでHTMLにレンダリングされるプログラミング言語のドキュメントプロジェクトについては、文字列（すべての文字列関数）、Web（すべてWeb関連の関数）、List（リスト処理に関係するもの）など。関数はいくつかのグループのメンバーになることができるので、ブログ記事と同じように、何らかの方法でタグを追加したい。タグを追加するためにSphinx拡張機

32熱

5答えて

Pythonでモジュール定数を文書化するには？

私はいくつかのグローバル定数が定義されたモジュールerrors.pyを持っています（注：私はPythonには定数がないことを理解していますが、大文字で慣習で定義しています）。 """Indicates some unknown error.""" API_ERROR = 1 """Indicates that the request was bad in some way.""" BAD_

5熱

1答えて

複数の用語を冗長なしに書く

用語を用語集にリンクしたいが、用語を複数にしたいという状況がよくあります。だから、通常、あなたは、単数形でこのような何かを： Some text before the term :term:`important words` then the stuff after the term これは解析されません： Some text before the term :term:`important

15熱

3答えて

複数行の記述は

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

5熱

2答えて

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

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

12熱

1答えて

reStructured Text（Sphinx）：ファイル名の置換？

1つのテンプレートから変数名だけが異なる複数のファイルを作成したいとします。（file1.rst）： .. |variable| replace:: 1 .. include template.rst （template.rst）：例えばのコースI「が./images/1-imageと呼ばれる画像を有する Variable |variable| =====================

13熱

2答えて

任意のラベルを作成せずにsphinx restructuredtextの見出しに内部リンクを張る方法は？

私は多くの見出しと小見出しを持つ文書を持っています。さらに本文には、見出しの1つにリンクしたいと思っています。 :ref:ラベルの冗長性なしでこれを行うにはどうすればよいですか？内容はちょうど良いヘッダーを拾うようだ。私はこのようなことを望んでいた：`#polled-data-retrieval`_。

7熱

1答えて

GitHubのドキュメントページに含まれるイメージのサイズを変更するには？

GitHubにREADME.rstページがありますが、リンクされたイメージのサイズを指定することができず、実際にリポジトリにそれらを含めたくありません。このようなSomethinkが動作するようになったが、GitHubのは、幅パラメータを無視するように思われた。https://github.com/pycontribs/jira を参照してください。 .. image:: http://blog

7熱

1答えて

README.rst内の画像がpypiに表示されない

私のパッケージをPyPIにアップロードすると、README.rstファイルにリンクされた画像が表示されます。私が持っている私のREADMEには： .. image:: example-python.png :height: 100px :width: 200px :scale: 100 % :align: center とMANIFEST.inで私が持っ