doc: add path to 'manpages' to conf.py #5855
Conversation
|
I hadn't looked at the README before, I wonder why it doesn't just say to run Anyway, would this change allow removal of the e.g. on line 430 here: Lines 428 to 433 in 9ecf7b2 |
|
Hmm, good question, I didn't think about that. Maybe so people don't have to build the code / run Edit: which is kinda nice for people who notice a problem with the documentation and don't want to build the whole project to open a PR! Yeah it would allow us to drop the PYTHONPATH thing, I'll fix that and force-push. |
jameshcorbett
force-pushed
the
doc-conf-path
branch
from
2e3744e
to
cdeb6a4
Compare
Good point! Though you don't have to build everything to build the docs, just However, this looks like a good improvement! |
|
Thanks! Setting MWP. |
Problem: sphinx-build cannot find the 'manpages' module which is in the same directory as conf.py. Add the directory to sys.path so it can be loaded.
jameshcorbett
force-pushed
the
doc-conf-path
branch
from
cdeb6a4
to
d7ee975
Compare
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## master #5855 +/- ##
==========================================
- Coverage 83.28% 83.27% -0.01%
==========================================
Files 513 513
Lines 82727 82727
==========================================
- Hits 68898 68893 -5
- Misses 13829 13834 +5 |
I ran into an issue building the documentation while following the README,
sphinx-buildcouldn't find themanpagesmodule. Adding the path tosys.pathmanually or on a one-off basis is easy enough but I think adding this will be a bit more foolproof?