Commit API docs and generate them using a separate task. #48
Conversation
This file contains 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
haiqi96
reviewed
Mar 15, 2024
docs/README.md
Outdated
| task docs:api-docs | ||
| ``` | ||
|
|
||
| * This will regenerate the API docs in `src/api`. You should run this whenever you change what |
There was a problem hiding this comment.
do we need the "what" in the sentence?
There was a problem hiding this comment.
Updated the wording.
| @@ -0,0 +1,7 @@ | |||
| clp\_ffi\_py.ir.native module | |||
There was a problem hiding this comment.
I have no idea what are those so I assume they are auto generated
haiqi96
approved these changes
Mar 15, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Currently, clp-ffi-py's API docs are built whenever the docs site is built. This has two issues:
This PR commits the API docs to the repo and builds them using a separate task that devs should run manually if they ever add/remove a package/module.
This PR depends on #46 being merged first.
Validation performed
task docs:servecontinues to work correctly.task docs:api-docsgenerates the API docs but doesn't change the committed docs (right now).