openstack
/
docs-specs
Code Issues Proposed changes

add a point about subdirectory index.rst files 

Change-Id: Id0fd0d395ac4d1956880eb2e7fa7f28bffcd57b5
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
This commit is contained in:
Doug Hellmann 2017-06-23 10:25:08 -04:00
parent eb74e55226
commit 3a999928ed
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
specs/pike/os-manuals-migration.rst
View File

@ -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
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
incorporates all of the documentation for the project by including
all of the subdirectories in a toctree.