Build API documentation #1219
Build API documentation #1219
Conversation
|
Warning! No news item is found for this PR. If this is a user-facing change/feature/fix, |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1219 +/- ##
=======================================
Coverage 79.64% 79.64%
=======================================
Files 17 17
Lines 1366 1366
=======================================
Hits 1088 1088
Misses 278 278 |
| @@ -45,7 +45,7 @@ The following lists key names mapped to its type and meaning for each entry. | |||
| :notes: list, any notes about the kickoff, optional | |||
| :status: string, status of the kickoff. Allowed values are {', '.join(PROJECTUM_STATI)}, optional | |||
|
|
|||
| Allowed values: | |||
There was a problem hiding this comment.
not sure the cause of these extra spaces provided throuhgout. I think this PR should only fix along doc/source/api/... right?
There was a problem hiding this comment.
I had a preliminary look. Please check my in-line comments. @tinatn29
For this PR, since we are modifying a lot, I think it would be safer for us to just do api_doc only? Also since there is one commit, I can't really track what manual modifications have been made.
|
closed without merging -- will redo this PR to separate commits and make sure |
built docs with
auto_api.pyper cookiecutting instructions (files in doc/source were modified) + fixed typos flagged by codespell.Besides fixing the typos, I didn't make any tweaks after
auto_apidid its thing, so let me know if any of the files modified should be different...did this build one of the two docs (or both) that @bobleesj mentioned in #1218?