.. _ch-intro:

Introduction

Creating a PhD thesis is typically done using LaTeX. This works really well for producing a PDF, but a giant PDF file is not a great way to put documents on the web. There are solutions that exist to turn latex source files into HTML, but in my experience, they tend to produce poor HTML output.

The Sphinx <http://sphinx.pocoo.org/>_ project is a wonderful tool for creating portable documents, allowing for output to many different formats. Unfortunately, it has many shortcomings when trying to typeset something so advanced as a PhD thesis. The aim of this project is to modify Sphinx to support all of the needs of a thesis writer. Many of the patches are not appropriate for contributing directly to the upstream Sphinx repository, so this is instead a separate project.

This sphinxtr output is available in several formats at: http://jterrace.github.com/sphinxtr.

The source code for sphinxtr can be found at: https://github.com/jterrace/sphinxtr.

.. image:: https://api.travis-ci.org/jterrace/sphinxtr.png :target: https://api.travis-ci.org/jterrace/sphinxtr

Installation

If you are running the apt packet manager you can install the requirements with the following command::

sudo apt-get install python-setuptools python-virtualenv texlive-full

Otherwise you can maybe find other ways to install the following packages:

• Python 2 <http://www.python.org/getit/>_ (preinstalled on most systems)
• Setuptools <https://pypi.python.org/pypi/setuptools/1.1.6#installation-instructions>_ (look for the most up to date version)
• Virtualenv <http://www.virtualenv.org/en/latest/#installation>_
• Tex Live <http://www.tug.org/texlive/quickinstall.html>_

Now create a virtualenv. This will help you to separate the requirements from this project from other Python projects you might have::

virtualenv venv
source ./venv/bin/activate

.. note::

You can get out of the virtualenv by either closing the terminal or by
calling ``deactivate``.

Then install the required Python packages::

pip install -r requirements.txt

Building

You need make. The following targets are supported:

html Builds HTML format, separated into sections singlehtml Builds HTML format on a single page text Builds text files, separated into sections singletext Builds a single text file latexpdf Builds into latex source files and then compiles into a PDF. Requires latex.

Changes

The following changes and additions have been made from vanilla Sphinx:

• A cross-format bibtex bibliography based on sphinx-natbib
• Tables that can go inside figures
• Changed table formatting to look pretty, like booktabs
• Improved alignment in table environment
• Added support for short captions that show up in the "list of figures" section
• Changed equation reference formatting from "(1)" to "1"
• Full customization of latex preamble and style file
• Numbered figures
• Numbered section references
• A singletext output that builds into a single text file, similar to singlehtml
• A subfigure environment

Documents Using sphinxtr

• Jeff Terrace's PhD Thesis <http://jterrace.github.com/sphinxtr>_