2017-06-13 5 views
1

個々のクラスとメソッドなどを文書化するためにnumpy docstringsを使用する方法を知っていますが、施設の環境で自分のパッケージを使用する方法をユーザーに示すページも必要です(Jupyterノートブック、私のパッケージをそこにロードする方法、環境をセットアップする方法、そして実際にそれを使用する方法)。スフィンクスで直接これを行う方法はありますか?あるいは、別のプログラムを使ってHTMLページを構築する必要がありますか?スフィンクスのチュートリアルページはどのように作成しますか?

答えて

1

一般的に、散文文書を書くときは、SphinxのdocsディレクトリにあるreStructuredTextファイルに直接書いてください。

だから、例えば、あなたはこのようになりますinstallation.rst作成したい:

.. toctree:: 
    :maxdepth: 2 

    installation 
    some_other_preexisting_page 
    another_preexisting_page 
:次に

Installation 
============ 

To access the Jupyter notebook, go to `this site <https://example.com>`_ 

は、あなたがこのような何かを見てindex.rstに内容のあなたのテーブルを編集したいです

(これはあなたのSphinxの設定がsphinx-quickstartのものと若干似ていることを前提としています)

関連する問題