DOC: build documentation as single PDF file (#168)
* DOC: add documentation building instructions
* DOC: add PDF download button on HTML pages
* DOC: embed package version in documentation
* DOC: increase resolution of the intensity distribution
* DOC: number sections on HTML build
* DOC: remove progress bars from Sphinx build
* DOC: switch to A4 paper PDF build
* DX: define `tox -e pdf` job
* DX: fail build if figures are missing in the PDF build
* DX: automatically push tags to GitLab
* FIX: set correct number of columns in LaTeX table
* MAINT: build PDF on GitLab CI
* MAINT: remove `READTHEDOCS_VERSION` variable
This is a remnant from repositories that host their documentation on
Read the Docs.
* MAINT: rewrite notebooks to make SVG visible in PDF
* MAINT: update pip constraints and pre-commit config
Co-authored-by: GitHub <noreply@github.com>
Showing
- .constraints/py3.10.txt 1 addition, 0 deletions.constraints/py3.10.txt
- .constraints/py3.7.txt 2 additions, 1 deletion.constraints/py3.7.txt
- .constraints/py3.8.txt 1 addition, 0 deletions.constraints/py3.8.txt
- .constraints/py3.9.txt 1 addition, 0 deletions.constraints/py3.9.txt
- .cspell.json 2 additions, 0 deletions.cspell.json
- .cspell/this-project.txt 10 additions, 0 deletions.cspell/this-project.txt
- .github/workflows/push-to-gitlab.yml 5 additions, 0 deletions.github/workflows/push-to-gitlab.yml
- .gitlab-ci.yml 8 additions, 1 deletion.gitlab-ci.yml
- README.md 38 additions, 1 deletionREADME.md
- docs/Makefile 20 additions, 0 deletionsdocs/Makefile
- docs/appendix/alignment.ipynb 13 additions, 4 deletionsdocs/appendix/alignment.ipynb
- docs/appendix/angles.ipynb 15 additions, 5 deletionsdocs/appendix/angles.ipynb
- docs/appendix/phase-space.ipynb 10 additions, 1 deletiondocs/appendix/phase-space.ipynb
- docs/appendix/serialization.ipynb 15 additions, 5 deletionsdocs/appendix/serialization.ipynb
- docs/conf.py 97 additions, 1 deletiondocs/conf.py
- docs/cross-check.ipynb 8 additions, 2 deletionsdocs/cross-check.ipynb
- docs/index.md 11 additions, 0 deletionsdocs/index.md
- docs/intensity.ipynb 57 additions, 13 deletionsdocs/intensity.ipynb
- docs/polarimetry.ipynb 62 additions, 40 deletionsdocs/polarimetry.ipynb
- docs/uncertainties.ipynb 80 additions, 18 deletionsdocs/uncertainties.ipynb
Loading
Please register or sign in to comment