Document doc strucure limitations

Docuement limitation to one 'master' index file at root of each document.

Change-Id: Ibe09eb71f5a6906267b6d9a68b80992d0ae7735d
Signed-off-by: Ron Stone <ronald.stone@windriver.com>
This commit is contained in:
Ron Stone 2024-12-17 14:46:13 +00:00
parent 16e1d08027
commit ba873c4690

View File

@ -215,6 +215,78 @@ Spec documentation is found in the
The ``specs/2019.03`` directory contains the documentation files for approved
and implemented specs.
------------------
Document structure
------------------
.. begin-document-structure
Each document consists of one Sphinx index file and some number of topic files.
The index file contains one or more *toctrees*, which define the manifest and
structure of topics to be included in the document. The index file must be at
the root of the document's folder structure.
.. important::
Additional indexes, either at the root of the document or in subfolders, are
not allowed.
Use section headings in the index file to define document structure. For
example:
.. code-block::
.. _contribute:
==================
Contributor Guides
==================
Welcome to the StarlingX community! We are glad you are here.
If you are new to the project, take a moment to review the
`StarlingX wiki <https://wiki.openstack.org/wiki/StarlingX>`_.
---------------------------
Contribute to documentation
---------------------------
.. toctree::
:maxdepth: 1
doc_contribute_guide
api_contribute_guide
release_note_contribute_guide
blog_contribute_guide
website_contribute_guide
------------------
Contribute to code
------------------
StarlingX follows the `OpenStack developer contribution guidelines
<https://docs.openstack.org/infra/manual/developers.html>`_. Additional
StarlingX-specific resources are listed below.
.. toctree::
:maxdepth: 1
development_process
/developer_resources/code-submission-guide
/developer_resources/debug_issues
--------------------
Additional resources
--------------------
* `StarlingX wiki <https://wiki.openstack.org/wiki/StarlingX>`_
* :doc:`/developer_resources/index`
.. end-document-structure
-------------
Writing style
-------------