Skip to content

Consolidate references in a single bibliography page - #1245

Closed
namurphy wants to merge 8 commits into
PlasmaPy:mainfrom
namurphy:bibliography
Closed

namurphy wants to merge 8 commits into
PlasmaPy:mainfrom
namurphy:bibliography

Conversation

@namurphy

Copy link
Copy Markdown
Member

Here's a pull request that would create a bibliography page. The way it's currently implemented does not require any additional Sphinx extensions (though an alternative would be to use sphinxcontrib-bibtex which has its own set of advantages & disadvantages). A trade-off analysis is given in #1243.

Here's what would need to be done before this would be able to be merged, if we decide to proceed with this approach:

  • Move citations from other docstrings to the bibliography page
  • Move citations from the narrative documentation to the bibliography page
  • Update documentation guide to describe how to add references
  • Link to relevant reST & Sphinx documentation from documentation guide

@github-actions github-actions Bot added the docs PlasmaPy Docs at http://docs.plasmapy.org label Aug 24, 2021
@codecov

codecov Bot commented Aug 24, 2021 •

Copy link
Copy Markdown

Codecov Report

Merging #1245 (36eef06) into main (d71d84b) will decrease coverage by 0.00%.
The diff coverage is n/a.

❗ Current head 36eef06 differs from pull request most recent head ffd67bb. Consider uploading reports for the commit ffd67bb to get more accurate results
Impacted file tree graph

@@            Coverage Diff             @@
##             main    #1245      +/-   ##
==========================================
- Coverage   97.07%   97.06%   -0.01%     
==========================================
  Files          73       73              
  Lines        7106     7095      -11     
==========================================
- Hits         6898     6887      -11     
  Misses        208      208              
Impacted Files Coverage Δ
plasmapy/dispersion/dispersionfunction.py 100.00% <ø> (ø)
plasmapy/simulation/particle_integrators.py 100.00% <ø> (ø)
plasmapy/simulation/particletracker.py 98.27% <ø> (ø)
plasmapy/conftest.py 100.00% <0.00%> (ø)
plasmapy/plasma/__init__.py 100.00% <0.00%> (ø)
plasmapy/particles/elements.py 100.00% <0.00%> (ø)
plasmapy/formulary/braginskii.py 99.72% <0.00%> (ø)
plasmapy/formulary/collisions.py 97.19% <0.00%> (ø)
plasmapy/formulary/mathematics.py 100.00% <0.00%> (ø)
plasmapy/formulary/dimensionless.py 100.00% <0.00%> (ø)
... and 6 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d71d84b...ffd67bb. Read the comment docs.

@namurphy namurphy added the PDD label Aug 25, 2021
@namurphy namurphy added the status: on hold Issues & PRs that are being intentionally delayed label Sep 15, 2021
@namurphy

Copy link
Copy Markdown
Member Author

Tentatively putting this on hold in favor of #1263.

@namurphy namurphy added the prototype 🏗️ Trying out an implementation on a trial basis label Sep 15, 2021
@namurphy

Copy link
Copy Markdown
Member Author

Superseded by #1263.

@namurphy namurphy closed this Sep 29, 2021
@namurphy
namurphy deleted the bibliography branch September 29, 2021 23:01
@namurphy namurphy removed the status: on hold Issues & PRs that are being intentionally delayed label May 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs PlasmaPy Docs at http://docs.plasmapy.org prototype 🏗️ Trying out an implementation on a trial basis

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant