ReadySET is a set of software engineering document
templates allowing a great starting point for developers when working on new or existing
ReadySET for Sphinx is an implementation of ReadySET for
Sphinx. Its goal is to give you all the rich content
of ReadySET, but using the power of Sphinx to allow you the flexibility of building your
documentation into different formats, and to include many of the powerful extensions for
This documentation content has been built into a skeleton Python project which takes care
of all library dependencies. The documentation content will be kept up to date with the
latest software methodologies and practices.
- Rich content / documentation structure sourced from ReadySET
- Easy editing of files using reStructuredText
- Build your documentation into HTML, PDF, QT Help, DevHelp, EPub, Latex, Man etc.
- Power of using existing Sphinx extensions like embedding Excel spreadsheets,
graphing, embedding sequence diagrams, spell checking etc.
You need to know basic shell commands for building the project. This project is implemented
using Python and Sphinx. Although you don't need to know these technologies, the more you
know, the more features you can use.
All templates use reStructuredText,
so its important to understand their markup formats.
Download and Installation
To download, click on the link below and save the file to a directory of your choice:
Once downloaded, you can uncompress the file with the following command:
tar xvf readysetsphinx-1.0.0.tar.gz
It will create a readysetsphinx-1.0.0/
folder. Navigate into this folder and run:
This will download the required setup / build tools.
When complete, you can then run:
This will download all the libraries needed in order to build your documentation
Editing and Building the Documentation
All the documentation files are in the docs/ sub folder. The .rst
files are the source files, and can be edited with your favourite text editor / IDE. When
you make changes to these files, you will need to build the source into a format of your
choice. For example, if you want to build HTML documentation, from the docs/
This will generate your documentation in a sub folder called _build/html. Using your
Internet browser of choice, if you open up the index.html file from that folder you will
see the generated documentation.
If you just run make on its own, it will display a list of targets. For
some of these targets like latexpdf, you might require some additional latex