Skip to content

A new (experimental) feature on Read the Docs supports multiple .readthedocs.yaml files for monorepos

License

Notifications You must be signed in to change notification settings

readthedocs-examples/example-monorepo

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Example of a monorepo setup on Read the Docs

Documentation Status

This project demonstrates having multiple .readthedocs.yaml files in the same repository in order to host nested documentation subprojects on Read the Docs.

You can read about the feature here:

https://docs.readthedocs.io/en/stable/guides/setup/monorepo.html

The feature is new (read: experimental).

This is an example of a Monorepo with 3 projects. Each project isn't highly developed nor pretty.

main

This is the "main" project that nests other subprojects. It uses the latest version of Sphinx.

blog

Completely different type of project. Builds with Sphinx 5.x.

Configured to be added as a subproject with alias "blog"

docusaurus

This project uses a completely different build environment with Node.

Configured to be added as a subproject with alias "docusaurus"

About

A new (experimental) feature on Read the Docs supports multiple .readthedocs.yaml files for monorepos

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published