Closed kloczek closed 1 year ago
@ocefpaf could you comment on this one?
I'd rather have the module installed when running sphinx. I'm planning on working on the docs as soon as I finish #120
Docs are building fine. @kloczek to solve that you can do a local edit install like pip install -e .
and build the docs.
Docs are building fine. @kloczek to solve that you can do a local edit install like
pip install -e .
and build the docs.
Reported issu has nothing to do in what kind os tate is source tree.
Please try to use -n
option during builnd docuemtation.
Upatet `sphinx-build outpu (nor it is more warnings)
First of all currently it is not possible to use straight
sphinx-build
command to build documentation out of source treeThis can be fixed by patch like below:
This patch fixes what is in the comment and that can of fix is suggested in sphinx example copy.py https://www.sphinx-doc.org/en/master/usage/configuration.html#example-of- configuration-file
Than .. on building my packages I'm using
sphinx-build
command with-n
switch which shows warmings about missing references. These are not critical issues.You can peak on fixes that kind of issues in other projects https://github.com/latchset/jwcrypto/pull/289 https://github.com/click-contrib/sphinx-click/commit/abc31069 https://github.com/latchset/jwcrypto/pull/289 https://github.com/RDFLib/rdflib-sqlalchemy/issues/95 https://github.com/sissaschool/elementpath/commit/bf869d9e https://github.com/jaraco/cssutils/issues/21 https://github.com/pywbem/pywbem/pull/2895 https://github.com/sissaschool/xmlschema/commit/42ea98f2