https://github.com/jmmanley/readthedocs-sphinx-multiproject-example

An example of how to use readthedocs with sphinx-multi project
https://github.com/jmmanley/readthedocs-sphinx-multiproject-example

documentation readthedocs sphinx sphinx-multiproject

Last synced: 4 months ago
JSON representation

An example of how to use readthedocs with sphinx-multi project

• Host: GitHub
• URL: https://github.com/jmmanley/readthedocs-sphinx-multiproject-example
• Owner: jmmanley
• Created: 2024-03-02T03:09:51.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-03-02T14:47:01.000Z (over 1 year ago)
• Last Synced: 2025-01-15T12:05:58.969Z (5 months ago)
• Topics: documentation, readthedocs, sphinx, sphinx-multiproject
• Language: Python
• Homepage:
• Size: 2.67 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
An example of how to use readthedocs with sphinx-multiproject!

No guarantee this is optimal, this was just my playground to get things working.

## package1

[![Documentation Status](https://readthedocs.org/projects/testingoutthedpocs/badge/?version=latest)](https://docs-test-project2.readthedocs.io/projects/package1/en/latest/?badge=latest)

## package2

[![Documentation Status](https://readthedocs.org/projects/docs-test-project2/badge/?version=latest)](https://docs-test-project2.readthedocs.io/en/latest/?badge=latest)

Note: you need a separate readthedocs project for each package.

Ensure that you specify the `PROJECT` [environmental variable](https://docs.readthedocs.io/en/stable/reference/environment-variables.html) with the name of the desired package to build.

If desired, you can add one project as a [subproject](https://docs.readthedocs.io/en/stable/subprojects.html) of another.

For example, I set `project1` as a subproject of `project2`.

Therefore, `project1` is available at both [`testingoutthedpocs.readthedocs.io`](https://testingoutthedpocs.readthedocs.io) and [`docs-test-project2.readthedocs.io/projects/package1/`](https://docs-test-project2.readthedocs.io/projects/package1/).