feat: add pdoc for leveraging python docstrings for documentation #501
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add pdoc, which is similar to the existing documentation, but uses existing python docstrings as the basis for documentation, then can also include markdown files. This PR creates a pdoc documentation site within the existing documentation directory for initial testing.
Feel free to reject if this is not useful given we already have some documentation. This may be considered just personal preference.
Example site: https://allenporter.github.io/ical/ical.html
See https://pdoc.dev/docs/pdoc.html for more background on how pdoc works.