Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Use sphinxcontrib-bibtex v2.1 and bibtex_bibfiles setting #1221

Merged
merged 9 commits into from
Jan 14, 2021

Conversation

matthewfeickert
Copy link
Member

@matthewfeickert matthewfeickert commented Dec 13, 2020

Description

Require sphinxcontrib-bibtex releases compatible with v2.0, which requires the definition of the bibtex_bibfiles in the Sphinx conf.py. With v2.0 Sphinx must be run twice to generate the bibliography:

It is good to be aware that the extension stores all citation information in a bibtex.json file in the source folder. If it does not exist, the file will be created on your first sphinx build, and you will have to rerun the build to make use of it. The file is automatically kept up to date, with a warning whenever you need to rerun the build (i.e. whenever your citations change). The file can be stored in version control if you do not want your users to have to run sphinx twice when they clone your project, or when you need your documentation to be built on an external service which only runs sphinx once.

Require sphinxcontrib-bibtex releases compatible with v2.1, which requires the definition of the bibtex_bibfiles in the Sphinx conf.py, thanks to mcmtroffaes/sphinxcontrib-bibtex#219 making the sphinxcontrib-bibtex v2.1 release series able to run with a single pass through a Sphinx build. 🎉

Requires PR #1220 to go in first.

ReadTheDocs build: https://pyhf.readthedocs.io/en/docs-use-sphinxcontrib-bibtex-v2.0/

Checklist Before Requesting Reviewer

  • Tests are passing
  • "WIP" removed from the title of the pull request
  • Selected an Assignee for the PR to be responsible for the log summary

Before Merging

For the PR Assignees:

  • Summarize commit messages into a comprehensive review of the PR
* Require sphinxcontrib-bibtex releases compatible with v2.1
* Add bibtex_bibfiles list to Sphinx conf.py
* Update RTD to Python 3.8 runtime

@matthewfeickert matthewfeickert added the docs Documentation related label Dec 13, 2020
@matthewfeickert matthewfeickert self-assigned this Dec 13, 2020
@matthewfeickert matthewfeickert added this to In progress in v0.6.0 via automation Dec 13, 2020
@codecov
Copy link

codecov bot commented Dec 13, 2020

Codecov Report

Merging #1221 (b45c8c4) into master (1f15258) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1221   +/-   ##
=======================================
  Coverage   97.47%   97.47%           
=======================================
  Files          63       63           
  Lines        3716     3716           
  Branches      525      525           
=======================================
  Hits         3622     3622           
  Misses         55       55           
  Partials       39       39           
Flag Coverage Δ
unittests 97.47% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out 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 1f15258...b45c8c4. Read the comment docs.

@matthewfeickert matthewfeickert added the CI CI systems, GitHub Actions label Dec 13, 2020
matthewfeickert added a commit that referenced this pull request Dec 13, 2020
* Compare floats to floats and not tensors in pytest.approx
* Add pytest and uproot3 to HEAD of dependencies workflow
* Restrict sphinxcontrib-bibtex to v1.X
   - c.f. PR #1221
@matthewfeickert matthewfeickert force-pushed the docs/use-sphinxcontrib-bibtex-v2.0 branch from 5c94073 to 58471e6 Compare December 13, 2020 16:46
@matthewfeickert
Copy link
Member Author

With v2.0 Sphinx must be run twice to generate the bibliography

I don't know how to get this to work on the RTD tests.

@matthewfeickert matthewfeickert force-pushed the docs/use-sphinxcontrib-bibtex-v2.0 branch from a8ca93a to c674121 Compare January 13, 2021 23:54
@matthewfeickert matthewfeickert marked this pull request as ready for review January 14, 2021 00:13
@matthewfeickert matthewfeickert changed the title docs: Use sphinxcontrib-bibtex v2.0 and bibtex_bibfiles setting docs: Use sphinxcontrib-bibtex v2.1 and bibtex_bibfiles setting Jan 14, 2021
@matthewfeickert
Copy link
Member Author

With v2.0 Sphinx must be run twice to generate the bibliography

I don't know how to get this to work on the RTD tests.

All issues are resolved with sphinxcontrib-bibtex v2.1.

.github/workflows/docs.yml Outdated Show resolved Hide resolved
v0.6.0 automation moved this from In progress to Reviewer approved Jan 14, 2021
@matthewfeickert matthewfeickert merged commit fd8fdf3 into master Jan 14, 2021
v0.6.0 automation moved this from Reviewer approved to Done Jan 14, 2021
@matthewfeickert matthewfeickert deleted the docs/use-sphinxcontrib-bibtex-v2.0 branch January 14, 2021 04:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI CI systems, GitHub Actions docs Documentation related
Projects
No open projects
v0.6.0
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

3 participants