Generate table of global substitutions to put in the documentation guide #2766
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
github-actions
bot
added
docs
github-actions
bot
added
the
maintenance
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2766 +/- ##
==========================================
+ Coverage 94.44% 95.23% +0.79%
==========================================
Files 107 107
Lines 9597 9597
Branches 2221 2221
==========================================
+ Hits 9064 9140 +76
+ Misses 343 273 -70
+ Partials 190 184 -6 ☔ View full report in Codecov by Sentry. |
namurphy
commented
Jul 16, 2024
| @@ -0,0 +1 @@ | |||
| Renamed :file:`docs/_cff_to_rst.py` to :file:`docs/_author_list_from_cff.py`. | |||
There was a problem hiding this comment.
🏷️ Mentioning in the name that this is for creating an author list should lead to more readable code.
It was working well just before this.
This is experimental.
|
@ejohnson-96 — thank you for the prompt review! |
This was referenced Jul 17, 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.
This PR adds functionality to
docs/_global_substitutions.pyto generate a table of the global substitutions that are used in the documentation. Here is a link to the RTD preview of the substitutions section which contains the table.The table is quite long, so I put it under a collapsible tab using
sphinx_collapse. The table is also quite wide because one of the substitutions includes some sentences to caution about unstable APIs, but that would take a while to fix so I'm okay with leaving it as-is.🎨 I also expanded usage of the
:rst:role so that in-line reStructuredText code snippets get formatted with pygments, which I think makes it considerably more readable.😩 All the nested backticks reminded me of writing the documentation guide in the first place!
Closes #1550.