1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47
|
"""
This configuration use sphinx-multiproject which builds multiple
Sphinx projects for the Read the Docs. We publish each project at read-the-docs
as orange3 RTD project's subproject. This config file is only required for the
Read the Docs build. Each documentation project can still be built separately
with sphinx-build (make html).
To select a documentation project that the RTD will build, set the PROJECT
environment variable in RTD subprojects to the documentation project name
(e.g. PROJECT=data-mining-library)
To test the documentation build locally run (from doc directory):
```
PROJECT="<project name>" sphinx-build . ./_build
```
More about shpinx-multiproject:
https://sphinx-multiproject.readthedocs.io/en/latest/index.html
"""
# pylint: disable=duplicate-code
extensions = [
"multiproject",
"sphinx.ext.autodoc",
"sphinx.ext.doctest",
"sphinx.ext.intersphinx",
"sphinx.ext.todo",
"sphinx.ext.coverage",
"sphinx.ext.mathjax",
"sphinx.ext.ifconfig",
"sphinx.ext.viewcode",
"sphinx.ext.autosummary",
"sphinx.ext.napoleon",
"recommonmark",
]
# Define the projects that will share this configuration file.
multiproject_projects = {
"data-mining-library": {
"path": "data-mining-library/source/"
},
"development": {
"path": "development/source/"
},
"visual-programming": {
"path": "visual-programming/source/"
},
}
|