Closed kloczek closed 2 years ago
Hi @kloczek thank you very much for reporting this.
I suspect that the warnings happen because you don't have ini2toml
installed in your environment.
The only methodology supported by this project to generate the docs is via tox -e docs
, which installs the package inside the same virtualenv used by sphinx
.
If you want to use a different methodology, please be sure to emulate the same behaviour as the one guaranteed by tox
.
Also note that currently -b man
is not supported (you are more than welcome to use it, but I don't have time to help debugging eventual issues with this option).
I suspect that the warnings happen because you don't have
ini2toml
installed in your environment. The only methodology supported by this project to generate the docs is viatox -e docs
, which installs the package inside the same virtualenv used bysphinx
.
Only handfull of pythin modules needs to be (still) installed to generate dosumentation. In this case it is possible to be able produce documentation out of source tree by use single line patch
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -11,6 +11,8 @@
import shutil
import sys
+sys.path.insert(0, os.path.abspath('../src'))
+
# -- Path setup --------------------------------------------------------------
__location__ = os.path.dirname(__file__)
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
If you want to use a different methodology, please be sure to emulate the same behaviour as the one guaranteed by
tox
.Also note that currently
-b man
is not supported (you are more than welcome to use it, but I don't have time to help debugging eventual issues with this option).
man output has nothing to do with those warnings.
Instead assume something please at least try to reproduce that issu by execute (with or without tox) sphinx-build command with '-n
option.
As the maintainer you do't need to support man output.
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
I am sorry, but I am not interested in this patch.
If you still want to waste time on wating to assembly tox env instead just generate documentation that is not my problem. You know already how to simplify that.
Plese try to reproduce that issue.
Looks like latest sphins shows a lot of warnings