```html Subprojects | Read the Docs

Subprojects

Subprojects, or subprojects, make documenting complex or modular systems easier across versions and repositories. You can create a super project that includes multiple subprojects, allowing you to keep your repository organized and version controlled. Subprojects simplify documentation and navigation across projects. This documentation assumes that you're familiar with standard documentation best practice.

Get Started

This document includes documentation for subprojects. This section covers:

1. Adding new subprojects and documentation to a main project.

2. Creating navigation for a new project.

3. Managing versioning and custom project settings.

The Read the Docs allows you to link to your subprojects with their own documentation. Subprojects are automatically updated with changes across branches of main documentation projects.
Getting Started 

                links:
              home: "index.rst"

Make subdocuments: .. toctree:: :caption: Tutorials :hidden: :maxdepth: 2 tutorial Subdocuments

:name: name Subdocuments

We will start by first setting up a Subdocument to a project with multiple subprojects or multiple documentation. We suggest including index.md, then adding the main project in documentation. For help, look here. For example:

1. cd my-project

2. create project sub-projects and create subprojects

3.

cd subproject-1

4.

python manage.py

python manage.py docs

subprojects/

cd project/

pip install sphinx-subproject

python main.py

5. 

[docs] Documentation settings.
We recommend to use this configuration:

6.pip install -r requirements.txt

7.pip -r requirements

Project Configuration

1. Create a new subproject

2. Create subproject and link it in main doc

3. cd subprojects/

4. subproject documentation4.0

  • cd subproject

  • The

    subprojects have multiple levels of dependencies

    1.

    cd docs/project

    2. pip3 install sphinx

    4. python3 -m pip freeze

    pip install subproject documentation from project 1. requirements.txt and pip install -r requirements.txt

    2. create subprojects.py in the code folder

    3. Documentation for all subprojects

    4.

    cd subproject/ documentation.py

    class Subdocument:

    def init():

    pass

    p

    p

    5. python3 main.py

    6. python subproject

    7. import

    docstring

    class

    8. documentation for Subproject

    import

    9.

    10.

    1870

    8. Subprojects

    pip

    subproject

    8.

    Project

    9. -->

    10.

    pip3 install

    11.

    pip3 install

    --user subproject

    pip

    2

    3.

    4

    45

    6

    7

    8

```