Open kloczek opened 2 years ago
thanks for reporting @kloczek! on readthedocs we specify that the package should be installed prior to building the docs. Isn't this an option for you instead of manipulating sys.path
?
thanks for reporting @kloczek! on readthedocs we specify that the package should be installed prior to building the docs. Isn't this an option for you instead of manipulating
sys.path
?
As you see on cost of two lines patch installation is not necessary. KISS pronciple .. On packaging software (anything else outside python domain) installation is not needed to generate documentation. Side effect of that patch is that it guarantees that documentation will be generated not out of installed module but just build one. copy.py file is in source tree sphinx semi configuration file. As that file will stay always in that tree there is no any other risk that such change will affect something.
Looks like sphinx is failing because missing entries in
sys.path
This can be fixed by patch:
However after that sphinx fails in other place
As dummy.py and dummy2.py are in docs/ final patch can look like below:
Wit habove documentation build corrctly.
It is yet another issue. On building my packages I'm usimg
sphinx-build
command with-n
swich which shows warnimgs about missing references. These are not critical issues. Here is the output with warnings:These are non-critical warnings 😄