pdoc3 does not generate html output
Open
Nobody has claimed this yet.
help wanted 🤷
- Dominant language
- Python
- Stars
- 1.2k
- Forks
- 146
- PR merge metrics
- No merged PRs in 30d
Description
Expected Behavior
As per the information in here I was expecting the documentation to be placed inside the html folder.
Actual Behavior
Is not happening.
Steps to Reproduce
sudo pip3 install pdoc3cd /myProjectpdoc3 --html -o ./html/ myProg.pu
Additional info
- pdoc version:
pip3 show pdoc3
Name: pdoc3
Version: 0.9.2
Summary: Auto-generate API documentation for Python projects.
Home-page: https://pdoc3.github.io/pdoc/
Author: UNKNOWN
Author-email: UNKNOWN
License: AGPL-3.0
Location: /usr/local/lib/python3.5/dist-packages
Requires: markdown, mako
Required-by:
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 documented pdoc3 command pdoc3 --html -o ./html/ myProg.pu with pdoc3 0.9.2 and compare its behavior with the command-line interface documentation. Done means the command successfully places the generated HTML documentation in the requested html folder.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100