add a point about subdirectory index.rst files
Change-Id: Id0fd0d395ac4d1956880eb2e7fa7f28bffcd57b5 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
This commit is contained in:
parent
eb74e55226
commit
3a999928ed
|
@ -278,6 +278,13 @@ repositories, instead of having the documentation team "push" it.
|
||||||
one to import the user guide, etc.). Submit these as patches on
|
one to import the user guide, etc.). Submit these as patches on
|
||||||
top of any previous patches.
|
top of any previous patches.
|
||||||
|
|
||||||
|
#. Ensure that there is an index.rst in each subdirectory of
|
||||||
|
doc/source so that the various landing pages managed by the
|
||||||
|
documentation team can link directly to that portion of the
|
||||||
|
documentation for your project. For example, in addition to moving
|
||||||
|
installation documentation into ``install/`` create
|
||||||
|
``install/index.rst`` with a ``toctree`` directive that shows all of
|
||||||
|
the installation.
|
||||||
#. Ensure that there is a top-level index.rst in doc/source that
|
#. Ensure that there is a top-level index.rst in doc/source that
|
||||||
incorporates all of the documentation for the project by including
|
incorporates all of the documentation for the project by including
|
||||||
all of the subdirectories in a toctree.
|
all of the subdirectories in a toctree.
|
||||||
|
|
Loading…
Reference in New Issue