sphinxcontrib-spelling 4.3.0

sphinxcontrib-spelling is a spelling checker for Sphinx-based documentation. It uses PyEnchant to produce a report showing misspelled words.

What’s new in 4.3.0?

  • Logging: use warning() instead of its deprecated alias (contributed by Sergey Kolosov)
  • Support additional contractions (contributed by David Baumgold)
  • require sphinx >= 2.0.0
  • declare support for python 3.6

sphinxcontrib.datatemplates 0.3.0

sphinxcontrib.datatemplates is an extension for Sphinx to render parts of reStructuredText pages from data files in formats like JSON, YAML, XML and CSV.

What’s new in 0.3.0?

  • Add dialect support, better dotumentation (contributed by Jan Brohl)
  • Use yaml.safe_load (contributed by Jan Brohl)
  • Add XML support (contributed by Jan Brohl)
  • Add CSV support (contributed by Jan Brohl)

sphinxcontrib.datatemplates 0.2.0

sphinxcontrib.datatemplates is an extension for Sphinx to render parts of reStructuredText pages from data files in formats like JSON, YAML, and CSV.

What’s new in 0.2.0?

  • Use sphinx.util.logging for logging calls (contributed by Sean McGinnis)
  • optionally exec the conf.py file and pass settings to the template
  • make test-template support python 2 and 3
  • update to python 3.5
  • add license file
  • Add links to repo and docs from README and docs frontpage (contributed by Christoph Deil)
  • add a command line tool to make testing templates easier

sphinxcontrib-spelling 4.2.1

sphinxcontrib-spelling is a spelling checker for Sphinx-based documentation. It uses PyEnchant to produce a report showing misspelled words.

What’s new in 4.2.1?

  • fix remaining logging issue (contributed by Timotheus Kampik)
  • Remove usage of deprecated logging API (contributed by Tim Graham)

sphinxcontrib-paverutils 1.15.0

sphinxcontrib-paverutils provides an alternative integration of Sphinx and Paver. It supports calling Sphinx from within Paver using multiple configurations, and does not assume you only want to build HTML output.

What’s new in 1.15.0?

  • handle errors in the sphinx portion of the build
  • if the outdir is set, use that instead of building a value

sphinxcontrib-paverutils 1.14.0

sphinxcontrib-paverutils provides an alternative integration of Sphinx and Paver. It supports calling Sphinx from within Paver using multiple configurations, and does not assume you only want to build HTML output.

What’s new in 1.14.0?

  • support pre-split command lines
  • add quiet option (contributed by Brad Miller)

Using Unicode with Sphinx, reStructuredText, and PDF Output

I’m working on updating my book, and besides actually writing the content one of the things I have to do is generate new LaTeX files to deliver to the publisher. I’ve written about my toolchain elsewhere, so I won’t repeat all of that information here. The short version is that I use Paver to drive Sphinx to convert reStructuredText input files to HTML for the website, LaTeX for the compositor at Pearson, and PDF for reviewers. Since the updated version covers Python 3, and one of the key benefits of Python 3 is better Unicode support, I want to include some characters outside of the normal ASCII set in my examples.

When you ask Sphinx’s latex builder to generate LaTeX output the result is a directory with a *.tex file containing your content and some other files with all of the parts you need to convert that LaTeX to other formats, including a Makefile with instructions for building PDF and DVI. By default that Makefile uses pdflatex to convert the *.tex output files it writes to PDF. My article for the random module includes an example of shuffling a card deck. The Python 2 version used letters to represent the card suits, but for Python 3 I switched to using Unicode symbols like what would appear on the cards. Making that work for HTML was easy, but the PDF output proved trickier.

Continue reading “Using Unicode with Sphinx, reStructuredText, and PDF Output”