4
私のプロジェクトの[ドキュメントを読む]ページを追加しています。今のところ、READMEのように、私のRead The Docsホームページにも同じ内容が必要です。これは主に相対リンクを除き、作品は、スフィンクスとギブスの相対リンクで同じREADMEコンテンツを使用します。
.. include:: ../README.rst
.. toctree::
:maxdepth: 2
:caption: Contents:
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
:私のdocs/index.rst
ファイルは次のようになります。例えば、私のREADMEが含まれています:スフィンクスは、docsディレクトリ内のすべてのものを構築しますので
See `INSTALL.rst`_ for advanced and detailed instructions.
を、docsディレクトリ内INSTALL.rst
を見つけることが期待されます。
Githubはルートからファイルをレンダリングするので、ルートディレクトリにINSTALL.rst
があると予想されます。
GithubとRead The Docs(Sphinx)を作成するにはどうすれば、重複ファイル(または好ましくは重複)を持たずに相対リンクを正しくレンダリングできますか?