How do you define your own latex preamble for sphinx autodoc?

Question

I'd like to use the latex algpseudocode package to add algorithms to my docstrings. I'd also like to be able to define user macros to speed up my maths equation typing in the docstrings.

I'm using napoleon autodoc style with sphinx to generate documentation from my docstrings.

Can you check if you have a `conf.py` file? https://www.sphinx-doc.org/en/master/latex.html — samcarter_is_at_topanswers.xyz, Jul 19 '21 at 14:54
That link was exactly what I needed, thank you. (It explains how to define your latex preamble in the conf.py file that gets created by sphinx-quickstart) — dan_sk8r, Jul 19 '21 at 15:03
You're welcome! Maybe you can summarise and post a short answer here so users with the same problem will be able to find it? — samcarter_is_at_topanswers.xyz, Jul 19 '21 at 15:05

score 2 · Answer 1 · answered Sep 23 '22 at 09:05

To add your own preamble in Sphinx. Create your own sty files with the LaTex edits and additions you want. Let's call these first.sty, second.sty. Now, modify the conf.py file ref. Sphinx-doc latex preamble Basically, for the example.

latex_additional_files = ['first.sty', 'second.sty']
latex_elements = { 
'preamble': r'\usepackage{first}',
'preamble': r'\usepackage{second}',
}

Run the following steps and verify the *.sty files show up in your buid/sphinx/latex directory, and your output includes your changes.

python setup.py build_sphinx -b latex
cd build/sphinx/latex
make

How do you define your own latex preamble for sphinx autodoc?

1 Answers1