documentation root folder and links to child pages
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.2k
- Forks
- 146
- PR merge metrics
- No merged PRs in 30d
Description
I'm working on calib3d python GitHub repository
Documentation is generated with
pdoc calib3d -o docs/ -c latex_math=True --force --html
GitHub pages is configured so that documentation points to main branch, docs/ folder, making it available at https://ispgroupucl.github.io/calib3d/
However i have two concerns (probably linked)
pdocbuilds the documentation inside a subfolderdocs/calib3d, making the documentation available inhttps://ispgroupucl.github.io/calib3d/calib3dinstead of expectedhttps://ispgroupucl.github.io/calib3d/. This can be resolved either by
(a) making a redirect inindex.htmltocalib3d/index.html(current implementation)
(b) making a symbolic linkindex.html -> calib3d/index.html(I also tested that one)- When using option (a) or (b), I can't have both the links defined in the docstring and the links in the "Sub-modules" section to work. One of the two link is broken (either by missing a
calib3din the url or by having onecalib3dtoo many in the url).
When using the local version pdoc calib3d --http localhost:8000 -c latex_math=True, both links work fine in the browser with both (a) and (b) approaches.
Questions
- What is the best practice when working with git pages? Where should the documentation be saved (
-ooption) and how should it be referenced using GitHub pages ? - How should the link in the docstring be defined?
Version
pdoc 0.10.0
python 3.8.3
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reproducing the pdoc 0.10.0 command with the generated output in docs/ and compare the GitHub Pages root URL with the calib3d subdirectory. Check how the docstring links and Sub-modules links are emitted in each layout; done means the documentation opens at the expected root and both link types resolve correctly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github, python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100