conf.py minor cleanups #556
Conversation
Uncomment line from tempate conf.py which allows build module documentation out of only source tree without have `msgpack` module installed. This will prevent as well building documetation against installed module whch mey be different version than what is in source tree. Signed-off-by: Tomasz Kłoczko <[email protected]>
Use already declared master_doc instead "index". Signed-off-by: Tomasz Kłoczko <[email protected]>
Declare author variable and add use already declared project and copyright. Signed-off-by: Tomasz Kłoczko <[email protected]>
| @@ -16,7 +16,7 @@ | |||
| # If extensions (or modules to document with autodoc) are in another directory, | |||
| # add these directories to sys.path here. If the directory is relative to the | |||
| # documentation root, use os.path.abspath to make it absolute, like shown here. | |||
| #sys.path.insert(0, os.path.abspath('..')) | |||
| sys.path.insert(0, os.path.abspath("..")) | |||
There was a problem hiding this comment.
did you see the commit comment in my "sphinx-related work" PR? #554
There was a problem hiding this comment.
did you see the commit comment in my "sphinx-related work" PR? #554
Nope .. just checked those comments.
Still without that tweak which it is not possible to build documentation without have module installed.
This kind of situation is when for example rpm package is build from non-root account and when it is not possible to install anything outside build tree.
In your commit tweaking sys.path still remains commented (only space is removed).
Even on generate documentation in CI it should help because it will be not necessary to install module.
If you don't lika that part just cherry pick PR with skipping that commit ..
There was a problem hiding this comment.
Still without that tweak which it is not possible to build documentation without have module installed.
Doesn't it mean you build doc from pure Python fallback, instead of Cython build?
Do you confirm that docs build from Cython code and pure Python fallback are completely same?
|
@kloczek sorry for the merge conflict caused here by merging my PR. I had to "fix" the imports in |
|
👍 |
Set of minor conf.py cleanups.