TeX Figure extension for Sphinx
Project description
Overview
sphinxcontrib-texfigure is a Sphinx extension for generating figures and diagrams from TeX files.
For an example of a diagram this extension could produce, please see http://htsql.org/doc/overview.html#htsql-in-a-nutshell. For more examples, see demo directory in the source distribution.
This extension is similar in scope to sphinxcontrib-tikz extension, but with different approach to input and options.
This software is written by Kirill Simonov (Prometheus Research, LLC) and released under BSD license.
Prerequisites
The following executables are used for rasterizing TeX documents:
- pdflatex
- pdftoppm
- pnmcrop
- pnmtopng
On a Debian or a Debian-derived system, they could be installed with:
# apt-get install texlive # apt-get install poppler-utils # apt-get install netpbm
If you want to generate diagrams with TikZ, install:
# apt-get install texlive-pictures
Usage
To enable this extension, add the following line to conf.py:
extensions.append('sphinxcontrib.texfigure')
Use texfigure directive to convert a TeX/LaTeX document to an image. For example:
.. texfigure:: hello-world.tex
This directive will render Hello, World! in a box assuming that hello-world.tex contains the following LaTeX document:
\documentclass{article} \usepackage{tikz} \pagestyle{empty} \begin{document} \begin{tikzpicture} \node[draw] {Hello, World!}; \end{tikzpicture} \end{document}
Use option align to specify horizontal alignment, alt to specify text content of the image:
.. texfigure:: hello-world.tex :align: center :alt: Hello, World!
Reference
Directives
- texfigure
Renders a figure from a TeX document.
The parameter of the directive must be the path to a TeX/LaTeX file. This directive has no body.
Options:
- align
- Horizontal alignment (left, center, or right)
- alt
- Alternative text content of the image.
Configuration parameters
- texfigure_pdftex (default: pdflatex)
- Path to pdftex or pdflatex executable.
- texfigure_pdftoppm (default: pdftoppm)
- Path to pdftoppm executable.
- texfigure_pnmcrop (default: pnmcrop)
- Path to pnmcrop executable.
- texfigure_pnmtopng (default: pnmtopng)
- Path to pnmtopng executable.
- texfigure_texinputs (default: [])
- List of directories where TeX searches for input files.
- texfigure_resolution (default: 110)
- Image resolution, in DPI.
CSS classes
- texfigure
- Applies to the generated image.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Filename, size | File type | Python version | Upload date | Hashes |
---|---|---|---|---|
Filename, size sphinxcontrib_texfigure-0.1.3-py2-none-any.whl (7.4 kB) | File type Wheel | Python version 2.7 | Upload date | Hashes View |
Filename, size sphinxcontrib-texfigure-0.1.3.tar.gz (6.8 kB) | File type Source | Python version None | Upload date | Hashes View |
Hashes for sphinxcontrib_texfigure-0.1.3-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 67f8f1b6ce4bbe2d8cbdbb3dd82b52afa68d5789333c4079d5f7a7c7e239b427 |
|
MD5 | 78e2b6ec6fad9003d95c5c3b519ec622 |
|
BLAKE2-256 | 4840dc6ca60dae7e2c8b4e7d712a7a59ed56988388923327b2d461a1de8798d1 |
Hashes for sphinxcontrib-texfigure-0.1.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 02511585d01052e4fa2ebc2bda9d242eae08aa9ac0142b2d4ab411d11fcc711e |
|
MD5 | b8799bfe8644108eb15fedbde330f64e |
|
BLAKE2-256 | bb7d6f9128033fa361d69c6f89a0c8d34dbfe5fa822a53ef3dc1a198aa3cff93 |