Skip to content

Initialize bibliography with sphinxcontrib-bibtex - #1263

Merged
namurphy merged 57 commits into
PlasmaPy:mainfrom
namurphy:sphinxbibtex
Oct 6, 2021
Merged

namurphy merged 57 commits into
PlasmaPy:mainfrom
namurphy:sphinxbibtex

Conversation

@namurphy

@namurphy namurphy commented Sep 14, 2021 •

Copy link
Copy Markdown
Member

This PR creates a documentation-wide bibliography page using sphinxcontrib-bibtex.

  • Update description of how to add references to documentation guide.
  • Include examples of how to include a reference with a URL in both the bibtex file and the documentation guide.

Closes #1243. This is an alternative to #1245.

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

codecov Bot commented Sep 14, 2021 •

Copy link
Copy Markdown

Codecov Report

Merging #1263 (b6831b7) into main (189dc2b) will decrease coverage by 97.09%.
The diff coverage is n/a.

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

@@            Coverage Diff             @@
##             main   #1263       +/-   ##
==========================================
- Coverage   97.09%       0   -97.10%     
==========================================
  Files          73       0       -73     
  Lines        7170       0     -7170     
==========================================
- Hits         6962       0     -6962     
+ Misses        208       0      -208     
Impacted Files Coverage Δ
plasmapy/utils/decorators/checks.py
plasmapy/dispersion/analytical/two_fluid_.py
plasmapy/dispersion/analytical/__init__.py
plasmapy/utils/pytest_helpers/pytest_helpers.py
plasmapy/formulary/dimensionless.py
plasmapy/analysis/__init__.py
plasmapy/utils/code_repr.py
plasmapy/formulary/collisions.py
plasmapy/particles/serialization.py
plasmapy/utils/__init__.py
... and 61 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 189dc2b...5349bcf. Read the comment docs.

Comment thread changelog/1263.doc.2.rst Outdated
Comment thread docs/refs.bib Outdated
@namurphy namurphy added the prototype 🏗️ Trying out an implementation on a trial basis label Sep 15, 2021
@namurphy
namurphy marked this pull request as draft September 15, 2021 01:10
@namurphy
namurphy requested a review from rocco8773 September 15, 2021 01:11
Comment thread docs/bibliography.rst Outdated
############

.. bibliography::
:all:

@namurphy namurphy Sep 15, 2021 •

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The :all: here makes it so that all of the references that are put into the .bib file are included in the bibliography, even if they're not referenced elsewhere. I'd be fine with either keeping it or dropping it, since there are alternatives that would allow including uncited references on a case-by-case basis.

Comment thread setup.cfg
@rocco8773 rocco8773 self-assigned this Sep 15, 2021
Comment thread docs/refs.bib Outdated
@github-actions github-actions Bot added the plasmapy.formulary Related to the plasmapy.formulary subpackage label Sep 16, 2021
Comment thread docs/development/doc_guide.rst Outdated
Comment thread docs/development/doc_guide.rst Outdated
Comment thread changelog/1263.doc.2.rst Outdated

@rocco8773 rocco8773 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks pretty good to me. Just address my above comments and then I'll be happy to slap this with an APPROVE!

namurphy and others added 3 commits October 5, 2021 12:42
Co-authored-by: Erik Everson <[email protected]>
@rocco8773

Copy link
Copy Markdown
Member

Closing in an attempt to force RTD to start building again, will reopen the PR.

@rocco8773 rocco8773 closed this Oct 5, 2021
@rocco8773 rocco8773 reopened this Oct 5, 2021
@rocco8773

Copy link
Copy Markdown
Member

Looks like there's a trailing whitespace error somewhere in the doc_guide.rst. Just not sure where, probably with one of my previous suggestions. 🤣

@namurphy
namurphy enabled auto-merge (squash) October 6, 2021 03:13
@namurphy
namurphy requested a review from rocco8773 October 6, 2021 03:13

@rocco8773 rocco8773 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me! I'm hopeful this will improve our citation mechanics. Thank you.

@namurphy
namurphy merged commit d28c7c5 into PlasmaPy:main Oct 6, 2021
@namurphy
namurphy deleted the sphinxbibtex branch October 6, 2021 22:47
@Sjbrownian Sjbrownian mentioned this pull request Dec 18, 2021
3 tasks
@namurphy namurphy removed the status: ready for review PRs that are ready for code review label Aug 15, 2022
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 plasmapy.formulary Related to the plasmapy.formulary subpackage prototype 🏗️ Trying out an implementation on a trial basis

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Create a documentation-wide bibliography page

2 participants