diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml index f040ef265d..2fa6691ced 100644 --- a/.github/workflows/gh-pages.yml +++ b/.github/workflows/gh-pages.yml @@ -31,6 +31,13 @@ jobs: mamba env update -n arc_env -f environment.yml conda list + - name: Install LaTeX + run: | + sudo apt install texlive-latex-base -y + sudo apt-get install texlive-latex-extra -y + sudo apt-get install -y dvipng + + - name: Install codecov run: mamba install -y -c conda-forge codecov diff --git a/docs/Makefile b/docs/Makefile index 9a31f67876..3d9a05c9ff 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -26,7 +26,7 @@ travis_setup: @git clone --single-branch --branch gh-pages --origin official https://${GH_TOKEN}@github.com/ReactionMechanismGenerator/ARC.git $(BUILDDIR)/html html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html -v @echo @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." diff --git a/docs/source/advanced.rst b/docs/source/advanced.rst index 1e472dade6..37c94e1a7a 100644 --- a/docs/source/advanced.rst +++ b/docs/source/advanced.rst @@ -847,11 +847,15 @@ ARC uses statistical mechanics software packages (e.g., Arkane) to compute rate the results of quantum chemistry calculations. By default, ARC instructs the statmech programs to compute rate coefficients in the modified three-parameter Arrhenius equation format: - .. math :: k(T) = A \left( \frac{T}{T_0} \right)^n \exp \left( -\frac{E_a}{RT} \right) +.. math:: + + k(T) = A \left( \frac{T}{T_0} \right)^n \exp \left( -\frac{E_a}{RT} \right) Alternatively, the user may request to compute the rate coefficients in the classical two-parameter Arrhenius format: - .. math :: k(T) = A \exp \left( -\frac{E_a}{RT} \right) +.. math:: + + k(T) = A \exp \left( -\frac{E_a}{RT} \right) by setting the ``three_params`` attribute to ``False`` (it is ``True`` by default). For example:: diff --git a/docs/source/api/job.rst b/docs/source/api/job.rst index ecc459ed34..b4dbcba86b 100644 --- a/docs/source/api/job.rst +++ b/docs/source/api/job.rst @@ -1,7 +1,7 @@ .. _job: -arc.job.job +arc.job =========== -.. automodule:: arc.job.job +.. automodule:: arc.job :members: diff --git a/docs/source/conf.py b/docs/source/conf.py index bda22b4eca..7a7d083623 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -131,7 +131,7 @@ # -- Options for LaTeX output ------------------------------------------------ - +imgmath_latex = 'latex' latex_elements = { # The paper size ('letterpaper' or 'a4paper'). # diff --git a/environment.yml b/environment.yml index 6082e34247..c19dd0dcd6 100644 --- a/environment.yml +++ b/environment.yml @@ -52,6 +52,7 @@ dependencies: - conda-forge::ase >=3.15.0 - anaconda::ipython - anaconda::sphinx + - anaconda::sphinxcontrib-jsmath - conda-forge::qcelemental - mako - pytables