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.

Sign up for GitHub

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
Merged

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

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
7741c6b
Use 2.0 API
matthewfeickert Dec 13, 2020
8905401
Add bibtex_bibfiles
matthewfeickert Dec 13, 2020
4f3bd17
Build sphinx second time
matthewfeickert Dec 13, 2020
1e0002b
Try to use Makefile
matthewfeickert Dec 13, 2020
cd2769f
Fixup paths
matthewfeickert Dec 13, 2020
7b0eb57
Use Python 3.8 for RTD builds
matthewfeickert Dec 13, 2020
c674121
Remove second run
matthewfeickert Jan 13, 2021
ca43cac
pushd and popd as better IMO
matthewfeickert Jan 14, 2021
b45c8c4
revert to setuptools
matthewfeickert Jan 14, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .github/workflows/docs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,9 @@ jobs:
- name: Test and build docs
run: |
python -m doctest README.rst
python setup.py build_sphinx
pushd docs
make html
popd
touch docs/_build/html/.nojekyll
- name: Check schemas are copied over
run: |
Expand Down
2 changes: 1 addition & 1 deletion .readthedocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ formats: all

# python -m pip install .[docs]
python:
version: 3.7
version: 3.8
install:
- method: pip
path: .
Expand Down
10 changes: 10 additions & 0 deletions docs/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,16 @@ def setup(app):
'sphinx_copybutton',
'xref',
]
bibtex_bibfiles = [
"bib/docs.bib",
"bib/HEPData_likelihoods.bib",
"bib/media.bib",
"bib/posters.bib",
"bib/preferred.bib",
"bib/talks.bib",
"bib/tutorials.bib",
"bib/use_citations.bib",
]

# external links
xref_links = {"arXiv:1007.1727": ("[1007.1727]", "https://arxiv.org/abs/1007.1727")}
Expand Down
2 changes: 1 addition & 1 deletion setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
extras_require['xmlio']
+ [
'sphinx>=3.1.2',
'sphinxcontrib-bibtex~=1.0',
'sphinxcontrib-bibtex~=2.1',
'sphinx-click',
'sphinx_rtd_theme',
'nbsphinx',
Expand Down