64 issues in pdoc3/pdoc
I'm pretty disgusted that someone has taken a project I built, relicensed it, attempted to erase its entry on the Python Wiki, released it under effectively the same name and, worst of all, associated ...
Add minimal example module and show off some of the features of pdoc.
Fixes https://github.com/pdoc3/pdoc/issues/50 Simpler module importing / better namespace package support. Breaks CLI API: Previously, for modules specified as relative file paths, python module path ...
Make CLI API more friendly such that it defaults to using localhost:8000 if no host/port is specified.
running pdoc --http :8001 PACKAGE serves the docs locally, but if any changes are made, the server needs to be manually killed and restarted, and the webpage needs to be reloaded. The PyPI package ...
update cli help
#58Add an additional note at the bottom directing users to the docs for more configuration options. Note: my text editor is configured to autoformat with black, so I saved the first commit with formatting ...
This makes the code easier to read since it's not underneath a large docstring. It also makes the documentation easier to edit since text editors can add syntax highlighting to the raw markdown content, ...
Really loving pdoc, it has everything I would expected in a doc generation tool except for Search. An example of a tool that does it really well is mkdocs with the mkdocs-material theme. Example docs: ...
GitHub pages are a common way to host documentation for sites. They require one of the following to host in source code: - master branch /docs folder - master branch - gh-pages branch Right now ...