Only report issues for pdoc3 package on PyPI. If your issue pertains to older pdoc package (on PyPI), report the issue here or ... just stop using it.
Before reporting an issue, see if a similar issue is already open. Also check if a similar issue was recently closed — your bug might have been fixed already.
To have your issue dealt with promptly, it's best to construct a minimal working example that exposes the issue in a clear and reproducible manner.
To install a developmental version of the project, first fork the project. Then:
git clone [email protected]:YOUR_USERNAME/pdoc
cd pdoc
pip3 install -e . # Mind the dot
Please write reasonable unit tests for any new / changed functionality. See pdoc/test directory for existing tests. Before submitting a PR, ensure the tests pass:
python setup.py test
Also ensure that idiomatic code style is respected by running:
flake8 --max-line-length 100
See doc/README.md. All documentation is generated from pdoc-compatible docstrings in code.
If you're new to proposing changes on GitHub, help yourself to an appropriate guide. Additionally, please use explicit commit messages. See NumPy's development workflow for inspiration.