pdoc3 / pdoc3/pdoc

documentation root folder and links to child pages

Open
#373 1 comment 0 reactions 0 assignees View on GitHub

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)

  1. pdoc builds the documentation inside a subfolder docs/calib3d, making the documentation available in https://ispgroupucl.github.io/calib3d/calib3d instead of expected https://ispgroupucl.github.io/calib3d/. This can be resolved either by
    (a) making a redirect in index.html to calib3d/index.html (current implementation)
    (b) making a symbolic link index.html -> calib3d/index.html (I also tested that one)
  2. 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 calib3d in the url or by having one calib3d too 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
  1. What is the best practice when working with git pages? Where should the documentation be saved (-o option) and how should it be referenced using GitHub pages ?
  2. How should the link in the docstring be defined?
Version

pdoc 0.10.0
python 3.8.3

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.