Repository navigation
Refactor plasmapy_sphinx - #1144
Conversation
…directives.confval
…lasmaPy typical format
…_sphinx.directives.event; delete any references to extras
rocco8773
added
the
no changelog entry needed
Codecov Report
@@ Coverage Diff @@
## master #1144 +/- ##
=======================================
Coverage 96.95% 96.95%
=======================================
Files 71 71
Lines 7027 7027
=======================================
Hits 6813 6813
Misses 214 214 Continue to review full report at Codecov.
|
namurphy
left a comment
namurphy
left a comment
There was a problem hiding this comment.
This was an admittedly quick review since I'm not familiar enough with sphinx and plasmapy_sphinx, but even so it is looking good and I'm happy for it to be merged. Just a few minor suggestions.
| `GitHub repository <https://github.com/plasmapy/plasmapy>`_. We do plan to breakout | ||
| `plasmapy_sphinx` into its own repository and release it to https://pypi.org at |
There was a problem hiding this comment.
| `GitHub repository <https://github.com/plasmapy/plasmapy>`_. We do plan to breakout | |
| `plasmapy_sphinx` into its own repository and release it to https://pypi.org at | |
| `GitHub repository <https://github.com/plasmapy/plasmapy>`_. We do plan to break | |
| `plasmapy_sphinx` out into its own repository and release it to https://pypi.org at |
[optional]
| definition. For example, doing ``:confval:`dummy_value``` will cross-link | ||
| to the ``dummy_value`` configuration value like :confval:`dummy_value`. Or, | ||
| a link to Sphinx's ``intersphinx_mapping`` configuration value goes like | ||
| ``:confval:`intersphinx_mapping``` -> :confval:`intersphinx_mapping`. |
There was a problem hiding this comment.
| ``:confval:`intersphinx_mapping``` -> :confval:`intersphinx_mapping`. | |
| ``:confval:`intersphinx_mapping``` → :confval:`intersphinx_mapping`. |
😬 u2192!
|
I had auto-merge enabled so none of your suggestions/corrections made it into the merge. I'll make the changes to the, yet to be opened, Lite-Function Ep. 2 PR (Ep. 1 PR is #1145). |
No worries! I noticed that after the fact. I made one of the changes in a different PR ( |
2 participants
After working on the lite-function functionality (PR #1145 & PR <still needs to be opened>), I realized
plasmapy_sphinxwasn't structured nicely for expansion. Thus, I've refactored the package structure to better reflect the structure ofsphinxand make where to place new functionality more intuitive. No new functionality has been add, but some documentation forplasmapy_sphinxhas been expanded.