pdoc3 doesn't use the latest version of the python file
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.2k
- Forks
- 146
- PR merge metrics
- No merged PRs in 30d
Description
I used pdoc3 do document my python package https://github.com/danleonte/Ambit_Stochastics. In particular, i used to run
```pdoc3 --html ambit_stochastics````
or
```pdoc3 --html ambit_stochastics --force````
When I try to do it now, pdoc doesn't use the python files in the folder, but some older version of that. For example, the code in https://danleonte.github.io/Ambit_Stochastics/trawl.html, which can be viewed via the 'expand code button', is different from the one in the github repo. Further, the latex code doesn't render anymore. I uninstalled and reinstalled pdoc3 and it didn t help.
More interestingly, even after i removed one of the scripts, pdoc3 still generated documentation for that script.
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 reported commands, pdoc3 --html ambit_stochastics and the --force variant, against the linked Ambit_Stochastics package. Compare the generated trawl.html and LaTeX output with the current repository, including after removing a script. Done means generated documentation reflects the current Python files, removed modules are absent, and LaTeX renders correctly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100