Generate API docs with pdoc #710
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Holger Frydrych <[email protected]>
armintaenzertng
approved these changes
Jul 6, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
This PR adds a workflow to auto-generate API docs with pdoc and publish them to GitHub pages.
Actions run: https://github.com/fholger/tools-python/actions/runs/5409859727
Preview: https://frydrych.org/tools-python/spdx_tools.html
While the generated docs do not offer much benefit over browsing the actual code in your IDE, they do provide a searchable and easily navigable web interface to look at the library structure. Given that it costs us virtually nothing to provide it, I believe we might as well have it.
Note: the GitHub pages configuration in the repository settings needs to be updated once to have the GH Pages deployed from a GitHub action instead of branch.