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

Get website documentation to display math #773

Merged
merged 5 commits into from
Jan 28, 2021
Merged

Get website documentation to display math #773

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7019faf
Tickle the CI
guyer Jan 13, 2021
d654626
Revise for sphinxcontrib-bibtex 2.x
guyer Jan 14, 2021
e47d8e6
Add LaTeX for imgmath in HTML
guyer Jan 14, 2021
8782504
Switch to SVG math and install prerequisites for math in html
guyer Jan 14, 2021
b719e00
Fix typo
guyer 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
21 changes: 11 additions & 10 deletions .circleci/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,16 +121,6 @@ commands:
default: "test-environment-27"

steps:
- run:
name: Install LaTeX
command: |
apt-get --yes update
apt-get --yes install texlive-latex-base
apt-get --yes install texlive-fonts-recommended
apt-get --yes install texlive-fonts-extra
apt-get --yes install texlive-latex-extra
apt-get --yes install texlive-science

- run:
name: Build Docs
command: |
Expand Down Expand Up @@ -499,6 +489,17 @@ jobs:
pip install numpydoc
conda install --channel conda-forge matplotlib pandas imagemagick

- run:
name: Install LaTeX
command: |
apt-get --yes update
apt-get --yes install texlive-latex-base
apt-get --yes install texlive-fonts-recommended
apt-get --yes install texlive-fonts-extra
apt-get --yes install texlive-latex-extra
apt-get --yes install texlive-science
apt-get --yes install texlive-extra-utils

- build_html_docs:
condaenv: << parameters.condaenv >>

Expand Down
1 change: 1 addition & 0 deletions documentation/ADMINISTRATA.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -228,6 +228,7 @@ into file:`documentation/_build` with::

$ tar -xzf dist/html.tar.gz -C documentation/_build


------
Upload
------
Expand Down
3 changes: 3 additions & 0 deletions documentation/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,8 @@
# The master toctree document.
master_doc = 'documentation/contents'

bibtex_bibfiles = ['documentation/refs.bib']

# General information about the project.
project = u'FiPy'
copyright = u'works of NIST employees are not not subject to copyright protection'
Expand Down Expand Up @@ -332,6 +334,7 @@
#latex_use_modindex = True

imgmath_latex_preamble = common_preamble
imgmath_image_format = "svg"

# refer to Python, NumPy, SciPy, matplotlib
intersphinx_mapping = {
Expand Down
2 changes: 1 addition & 1 deletion documentation/references.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,6 @@
References
==========

.. bibliography:: /documentation/refs.bib
.. bibliography::
:style: unsrt
:all: