python-sphinx

0熱

1答えて

私はPortable Python 2.7.6.1を使用していて、マニュアルを作成するためにSphinx 1.5.1をインストールしました。 Sphinxはすでに数十年前に多くの進歩を遂げたため、最新バージョンのSphinx 1.6.5にアップデートしようとしていましたが、easy_installツールを使用してアップグレードできませんでした。私が試した： easy_install-2.7.ex

0熱

1答えて

toctreeエントリを追加するには

私はPythonを文書化するためにSphinxを始めようとしています。始めにいくつかの非常に基本的なステップが欠けているようです。私はhttp://www.sphinx-doc.org/en/stable/tutorial.htmlに従っており、可能であればデフォルトでツールをインストールして設定しています。問題は、インデックスに別のRSTファイルをリンクできないことです。私のインデックスファ

2熱

1答えて

他のテンプレートでSphinxを使用するには？

私は新しいモジュールのドキュメントを書こうとしていますが、sentry.ioのドキュメントに触発されており、彼らはSphinxモジュールを使用していますが、インターフェイスはデフォルトではありません。テンプレートを変更する方法はありますか、または隊列隊は独自の目的のために作成しましたか？

1熱

1答えて

内部インデント付きRSTコードブロック

私はSphinxを使用して、辞書を返すメソッドを文書化しています。 def do_stuff(foo, bar): """Do some stuff :param foo: I'm an argument :param bar: So am I :return: dict:: { "success": (Boolean) Tr

0熱

1答えて

スフィンクスのサイドバーにモジュールへのリンクを置く方法は？

私は自分のプロジェクトのドキュメントをsphinxで書いています。サイドバーにモジュールへのリンクを入れたいと思います。フロントページにリンクを置くことはできますが、サイドバーにはリンクを置くことはできません。 index.rst .. DashBoard documentation master file, created by sphinx-quickstart on Tue Dec 12

1熱

1答えて

Python-SphinxにLatexの\ endinputに相当するものがあります

LateXとPython-Sphinxは、書式設定されたコンテンツをターゲットドキュメントに変換するワードプロセッサです。大きな文書を扱うときの通常のワークフローは、小さなファイル（セクション、章）で分割し、特定のファイルを目次として使用することです（ほとんどのLatexプロジェクトではmain.tex、Sphinxではindex.rst）。ラテックスでは、\endinputコマンドを使用して特

0熱

1答えて

SWIGで生成されたPythonファイルのPythonモジュールのインポート中にエラーが発生する

SWIGがCコードで生成したいくつかのPythonインターフェイスモジュールのドキュメントを生成しようとしています。私はポストを述べたように（* .I）SWIGインタフェースファイルで%feature(docstring)ディレクティブを使用しています：意図したとおりに Sphinx and documenting python from a swigged C++ api SWIGが生成したPy

0熱

1答えて

sphinx mathjaxオフラインでanacondaディストリビューション

私はmathjaxでオフラインでsphinxを実行しようとしています。私はlatexでipythonノートブックを実行するanacondaディストリビューションを使用しています（mathjaxと思います）。私は拡張子でsphinx.ext.mathjaxを持っていると私はオンラインだとき、すべてが正常に動作します。私がオフラインになると、ラテックス方程式はレンダリングされません。私はipyth

0熱

1答えて

autodoc：インポートを尊重するのではなく、フルネームで基本クラスが表示されます

私はこの非常に複雑な問題に対して、ここで解決策を見つけることを願っています。私はプロジェクトを文書化するためにsphinxとintersphinxを使用します。私はmongoengine.Documentから継承するクラスを持っています。 sphinx-apidocとsphinx-build（sphinx-quickstartで自動生成されたMakefile経由）を使ってsphinxドキュメン

0熱

1答えて

BokehプロットスフィンクスのJSパスgh-pagesでホストされたhtml

私はgh-page上のいくつかのsphinxベースのドキュメントを、bokeh-plot拡張を使ってRSTファイルの 'bokeh-plot'ディレクティブを使ってホストしようとしています。私は生成されたhtmlと関連JSを提供して、ローカルホストフラスコサーバーでうまく動作するインタラクティブなプロットを得ることができます。私の問題は、プロット用に生成されたスクリプトがトップレベルの 'scr