I have an open source project split into different repositories, which I 
would like to document on a single readthedocs page (using, for instance, 
sphinx.ext.autosummary).

For now, the Sphinx conf.py and the master toctree document are contained 
in a separate docs repo:

docs
├── index.rst
├── conf.py
└── ... foobar
├── foo
│    └── __init__.py
└── bar
├── __init__.py
└── baz
└── __init__.py 

Building the Sphinx documentation locally, I could simply download all 
repositories and use relative paths <https://stackoverflow.com/a/45953127> to 
direct Sphinx to the different repositories, e.g.:
sys.path.insert(0, os.path.abspath('../foobar')) 

However, this won't work building the project at readthedocs.org.

I searched, but found only one solution 
<https://stackoverflow.com/a/66186901> that *"(copies) all of the packages 
within the repo to a temporary folder, which will allow the docstring tool 
to scan and then generate the relevant docs."* In a variation of this 
<https://stackoverflow.com/a/17217041>, symlinks are to be used.

This is likely not the optimal solution. Am I missing some basic 
functionality of Sphinx?

-- 
You received this message because you are subscribed to the Google Groups 
"sphinx-users" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
To view this discussion on the web visit 
https://groups.google.com/d/msgid/sphinx-users/f8bd8f94-a30f-44ee-b22b-8559a612ba49n%40googlegroups.com.

Reply via email to