Sync outdated developer API docs, add check in CI #1525
Merged
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
victorlin
force-pushed
the
victorlin/docs-generation
branch
3 times, most recently
from
0123691
to
4c5aa46
Compare
victorlin
changed the title
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1525 +/- ##
==========================================
+ Coverage 69.63% 69.69% +0.05%
==========================================
Files 74 74
Lines 7812 7827 +15
Branches 1910 1914 +4
==========================================
+ Hits 5440 5455 +15
Misses 2086 2086
Partials 286 286 ☔ View full report in Codecov by Sentry. |
Reflects the public/developer split from a single Python API.
This makes it easier to understand what's going on.
Command from dev docs:
sphinx-apidoc \
--force \
--module-first \
--separate \
--no-toc \
--output-dir docs/api/developer \
augur
Warnings were:
augur/curate/__init__.py:docstring of augur.curate.create_shared_parser:5: WARNING: Inline literal start-string without end-string.
augur/curate/__init__.py:docstring of augur.curate.create_shared_parser:5: WARNING: Inline literal start-string without end-string.
It took some searching¹ + trial and error to figure out the fix.
¹ <sphinx-doc/sphinx#9140 (comment)>
Warnings were:
augur/curate/apply_geolocation_rules.py:docstring of augur.curate.apply_geolocation_rules.load_geolocation_rules:9: WARNING: Definition list ends without a blank line; unexpected unindent.
augur/curate/apply_geolocation_rules.py:docstring of augur.curate.apply_geolocation_rules.load_geolocation_rules:10: WARNING: Definition list ends without a blank line; unexpected unindent.
augur/curate/apply_geolocation_rules.py:docstring of augur.curate.apply_geolocation_rules.load_geolocation_rules:11: WARNING: Definition list ends without a blank line; unexpected unindent.
augur/curate/apply_geolocation_rules.py:docstring of augur.curate.apply_geolocation_rules.load_geolocation_rules:12: WARNING: Definition list ends without a blank line; unexpected unindent.
Warnings were:
<unknown>:1: WARNING: py:class reference target not found: argparse._SubParsersAction
<unknown>:1: WARNING: py:class reference target not found: argparse._SubParsersAction
These files are not referenced by the auto-generated docs.
Since augur.io is in both the public and developer APIs, only one can be used for cross referencing meaning the other must have `:noindex:`. Ideally the developer API docs would have `:noindex:` so the public API docs can list all exported functions on its index page. However, regenerating the developer API docs using sphinx-apidoc will remove the `:noindex:` so that's not a direct option without digging further.
victorlin
force-pushed
the
victorlin/docs-generation
branch
from
50af199
to
696284c
Compare
victorlin
force-pushed
the
victorlin/docs-generation
branch
from
696284c
to
3e7c3d8
Compare
|
Merged without review per Slack message |
4 tasks
jameshadfield
added a commit
that referenced
this pull request
Jul 10, 2024
Following instructions in `DEV_DOCS.md` and the (forthcoming) PR <https://github.com/nextstrain/augur/pull/1527/files>. These docs were missed during development of the rename command <#1506> as that predated the CI checks added in <#1525>
4 tasks
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 of proposed changes
Related issue(s)
Checklist