Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Online documentation #57

Open
timothyb0912 opened this issue Sep 5, 2020 · 2 comments
Open

Online documentation #57

timothyb0912 opened this issue Sep 5, 2020 · 2 comments
Assignees
@timothyb0912
Labels
documentation

Comments

@timothyb0912
Copy link
Owner

Request

Create online documentation as in a readthedocs page or something similar.
@timothyb0912 timothyb0912 self-assigned this Sep 5, 2020
@timothyb0912
Copy link
Owner Author

timothyb0912 commented Dec 9, 2020 •
edited
Loading

Ah, see pdocs for easy, automatic, online-documentation creation from project docstrings.
See pytikz for a real and minimal project showing how to use pdoc3.

This should be combined with interrogate to automatically discover which parts of the codebase are missing docstrings. This will help keep the documentation up to date.

@timothyb0912
Copy link
Owner Author

See mkdocs for "manual" building of documentations sites.
See portray for combining pdocs and mkdocs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@timothyb0912 timothyb0912

Labels
documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@timothyb0912