You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
5fc37f7 adds a simple pdoc workflow & deploys to GH Pages on pushes to main. Some tweaks should still be made before explicitly pointing to it but it's a good starting point.
CLI documentation needs some looking at. While the function documentation is being correctly pulled, because Typer is providing the command grouping the CLI structure is not captured by pdoc so the documentation does not make clear what each function belongs to.
It would also be helpful to figure out how to incorporate some of the other markdown documents as their own pages, e.g. the README, contributing doc, and data model doc.
As much as I like having the pdoc one-liner, it might be better in the long run to do something more like https://github.com/mkdocs/mkdocs + https://github.com/mkdocstrings/mkdocstrings to allow for better customizability, particularly around the CLI documentation where pdoc has a tough time following along with typer's structure
The README is already getting a bit long, it's probably worth investigating generating some static docs. Can probably use GH Pages?
pdoc3 looks like it could fit the bill.Rather use pdoc instead.
The text was updated successfully, but these errors were encountered: