Repository navigation
Move substitutions from common_links.rst to doc_guide.rst - #2272
Conversation
|
Thank you for submitting a pull request (PR) to PlasmaPy! ✨ The future of the project depends on contributors like you, so we deeply appreciate it! 🌱 Our contributor guide has information on:
The bottom of this page shows several checks that are run for every PR. Don't worry if something broke! We break stuff all the time. 😺 Click on "Details" to learn why a check didn't pass. Please also feel free to ask for help. We do that all the time as well. 🌸 You can find us in our chat room or weekly community meeting & office hours. Here are some tips:
If this PR is marked as ready for review, someone should stop by to provide a code review and offer suggestions soon. ✅ If you don't get a review within a few days, please feel free to send us a reminder. Please also use SI units within PlasmaPy, except when there is strong justification otherwise or in some examples. We thank you once again! |
github-actions
Bot
added
docs
Codecov ReportPatch and project coverage have no change.
Additional details and impacted files@@ Coverage Diff @@
## main #2272 +/- ##
=======================================
Coverage 98.37% 98.37%
=======================================
Files 98 98
Lines 8533 8533
=======================================
Hits 8394 8394
Misses 139 139 ☔ View full report in Codecov by Sentry. |
github-actions
Bot
added
CI
|
Next step:
|
| add and cite references to PlasmaPy's global bibliography BibTeX_ file, | ||
| :file:`docs/bibliography.bib`. (`#1263 <https://github.com/plasmapy/plasmapy/pull/1263>`__) | ||
| - Added sphinxcontrib-bibtex_ as a Sphinx_ extension to enable references | ||
| - Added ``sphinxcontrib-bibtex`` as a Sphinx_ extension to enable references |
There was a problem hiding this comment.
Most of these substitutions were used only in the documentation guide and a changelog entry. It's not important to have these links in the changelog entries, so I'm converting them to in-line code-snippets.
| .. ---------------------- | ||
| .. Nested inline literals | ||
| .. ---------------------- | ||
|
|
||
| .. A workaround for nested inline literals so that the filename will get | ||
| formatted like a file but will be a link. In the text, these get used | ||
| with the syntax for a substitution followed by an underscore to | ||
| indicate that it's for a link: |docs/_static|_ | ||
|
|
||
| .. For these workarounds, if the replacement is something in single back | ||
| ticks (e.g., `xarray`), then it should also be added to | ||
| nitpick_ignore_regex in docs/conf.py so that it doesn't get counted | ||
| as an error in a nitpicky doc build (e.g., tox -e doc_build_nitpicky). |
There was a problem hiding this comment.
This was copied verbatim from docs/common_links.rst so it's already been reviewed in a previous pull request.
…links-stuff-to-doc-guide
github-actions
Bot
removed
CI
|
Merging this to avoid merge conflicts in #2281. |
We use
docs/common_links.rstas a place to define links and substitutions across the documentation. Essentially the content incommon_links.rstgets added to the epilogue of each.rstfile and docstring. This has the potential to slow down documentation builds.This PR is an attempt to consolidate some of the shortcuts into the documentation guide, since that's the main place that they get used.
Unfortunately we don't have a good or consistent way to benchmark documentation builds yet, so I don't know for sure that it'll speed things up noticeably. At the very least, it'll keep these definitions in a place that's closer to where they get used.