restructuredtext

0熱

1答えて

再構成されたテキスト/ Sphinxで文書化する際に、パラメータの型を宣言とともに含めるにはどうすればいいですか？

私はそうのような2行使用してPythonの関数のパラメータを文書に精通しています： def get_market_history(self, market, count): """ Used to retrieve the latest trades that have occured for a specific market. /market/getm

2熱

1答えて

README.rstはpypiで解析されていませんが、testpypiでの用量

私のパッケージの新しいバージョンをリリースした後、何らかの理由でpypiがREADME.rstの表示を停止しました。 README.rstファイルの2つのバージョンの間に変更点は最小であり、ここではthe diffです。私はそれを壊したことを理解できません... 私はまた、testpypiにアップロードしようとしましたが、驚き私はそれを完全に見ることができます。リンク何が悪かったのかリンクp

2熱

1答えて

どのようにして生成されたインデックスページをReadTheDocsナビゲーションバーにリンクできますか？

私はReadTheDocsで自分のテーマを使ってSphinxでドキュメントを作成しています。 Indexページへリンク：作成 Link to the :ref:`genindex` page. ：ビルドプロセスがで参照することができgenindex.htmlファイルを生成します。それはrendertimeに存在しない、自動生成されたファイル、だから .. toctree: foo

1熱

1答えて

Sphinxでマニュアルページとしてレンダリングされる再構成されたテキストのオプションリストをどのようにフォーマットしますか？

私はコマンドラインツールのドキュメントを再構成されたテキストとして書く予定です。私はSphinxを使ってドキュメントをレンダリングしています。 htmlターゲットの横に、端末で読み取ることができるドキュメントを提供するために、manターゲットをoderで使用したいと考えています。 Sphinxのマニュアルで関連する設定変数が見つかったにもかかわらず、マニュアルページで2列テーブルとしてよく見られる

2熱

1答えて

Sphinx（reST）のインラインコードハイライト

Sphinxを使用しているときにインラインコードスニペットを強調表示しようとしています。私はInline code highlighting in reStructuredTextで提供された解決策を見てきましたが、それは私のためには機能しません。私はSphinx 1.4.8を使用しています。ハイライトされるインラインコードをマーキングするもう1つのシンプルでエレガントな方法はありますか？真

0熱

1答えて

Sphinxの "only"と "ifconfig"の違いは何ですか？

スフィンクスは条件付きコンテンツのための2つのディレクティブを知っている：のみ=>http://www.sphinx-doc.org/en/1.4.8/markup/misc.html#tags ifconfigコマンド=>http://www.sphinx-doc.org/en/1.4.8/ext/ifconfig.html をそれらの間の違いは何ですか？

-1熱

1答えて

reStructuredText内の異なるターゲットに同じテキストをリンクする

reStructuredTextでは、2つのリンクが同じテキストを持っていてもターゲットは異なるようにするにはどうすればよいですか？次のスクリプトは動作しませんが、あなたはポイントを得るのを助けることができます。 This Python_ is not the same as that Python_. .. _Python2: https://docs.python.org/2/ .. _

3熱

4答えて

コマンドラインツールの使い方をREADME.rstに追加する

私は少しコマンドラインツールを書いて、 "--help"という使い方のメッセージをドキュメントに追加したいと思っています。私は怠け者なので、できるだけ簡単に更新手順を作りたいと思います。更新ワークフローに次のようにしたいと思います：更新プログラムの使用状況メッセージが表示されます。ドキュメントを更新するスクリプトを実行する：新しい使用法のメッセージがドキュメントに表示されるはずです。他の言