Articles

Articles allow you to include extra content in the documentation that is generated for your model.

Articles may be reStructuredText (.rst) or MyST Markdown (.md), and are included in generated Sphinx documentation without changing their source syntax. Articles is optional and documentation-only; articles do not become runtime model classes or JSON/XML content.

See also

See the Sphinx reStructuredText guide or the MyST Markdown documentation for the selected source format.

toc.txt

To include an article in the top level table of contents generated by Sphinx, you can include the path of the article in the baseDirectory/Articles/toc.txt file. This file contains one relative, normalized path per nonblank line. Paths must remain inside Articles, must resolve with exact case, and must not be duplicated.

Example Layout

As an example, assume the following directory structure.

• baseDirectory/

  • Articles/

    • toc.txt

    • about/

      • index.rst

      • contact-us.rst

      • license.rst

In this case, the toc.txt file might contain a reference to about/index. The rest of the files do not need to be added because they can be references from the about/index.rst file.