Closed kloczek closed 2 years ago
We do not support -n
yet, this is a duplicate of https://github.com/falconry/falcon/issues/1888. Please use -W
for the time being.
You can use tox -e docs
to build the docs in the same way as we do in the CI. But I'm not opposed to adding sys.path
either, particularly considering Falcon has no hard 3rd party dependencies, so it could enable your usage pattern.
We can accept a PR if you care to add this statement for us.
Reported issue has nothing to do with sys.path
alteration which I;m using. I've added this only as side note showing how simpler (without tox) build documentation and have guarantee that it will be generated not out of installed module but what is is in source tree.
OK, thanks, closing this as a duplicate then.
Duplicates #1888
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:
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.Here is the output with warnings:
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