Skip to content

doc/requirements: update #1982

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

Merged
merged 1 commit into from
Feb 23, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
14 changes: 3 additions & 11 deletions doc/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# used by Read The Docs to install python required
# modules with pip.

Sphinx==3.1
sphinx
sphinx_rtd_theme

# Support custom domains
Expand All @@ -16,16 +16,8 @@ myst_parser
git+https://github.com/SymbiFlow/sphinxcontrib-markdown-symlinks

#Handle references in bibtex format
#
# To work around citations not resolving we need to use a version < 1 (0.4.2 is the latest), until
# we upgrade to using sphinx-2.0
sphinxcontrib-bibtex==0.4.2

#Work-around bug "AttributeError: 'Values' object has no attribute 'character_level_inline_markup'" with docutils 0.13.1
#See:
# * https://github.com/sphinx-doc/sphinx/issues/3951
# * https://sourceforge.net/p/docutils/bugs/304/
docutils==0.17.1

sphinxcontrib-bibtex

#Generates a project specific 404 (page not found) page
sphinx-notfound-page
Expand Down
1 change: 1 addition & 0 deletions doc/src/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@

if have_sphinxcontrib_bibtex:
extensions.append("sphinxcontrib.bibtex")
bibtex_bibfiles = ["z_references.bib"]
else:
print(
"Warning: Could not find sphinxcontrib.bibtex for managing citations, attempting to build anyway..."
Expand Down