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

Find a way to catch TeX rendering issues within docs build step in the CI #132

Open
DanielKotik opened this issue Mar 7, 2022 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed

Comments

@DanielKotik
Copy link
Contributor

At the moment, if math (TeX) expressions in the docs contain errors that lead to invalid TeX, those errors will become visible only when after the docs are built. It would be nice to allow the CI to catch such errors before the documentations goes online.

I have already done some research, but have not found a quick or easy solution.

See also: https://docs.mathjax.org/en/latest/options/input/tex.html#tex-formaterror

@DanielKotik DanielKotik added documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed labels Mar 7, 2022
@DanielKotik DanielKotik self-assigned this Mar 7, 2022
@DanielKotik
Copy link
Contributor Author

DanielKotik commented Mar 7, 2022

A solution might be

  1. add 'sphinx.ext.imgconverter' to conf.py
  2. in /docs run make latex
  3. cd ./_build/latex
  4. latexmk -pdf -halt-on-error

It probably becomes necessary to adjust .gitignore to ignore files such as source.aux, source.fdb_latexmk, texput.fls, output.log. Also check that only the html part of the build directory will be moved to gh pages artifact.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant