template icon indicating copy to clipboard operation
template copied to clipboard

A template Sphinx repo

Template

.. image:: http://unmaintained.tech/badge.svg :target: http://unmaintained.tech :alt: No Maintenance Intended

Note: This template is not maintained anymore, use the tutorial <https://github.com/readthedocs/tutorial-template/>_ instead.

$project will solve your problem of where to start with documentation, by providing a basic explanation of how to do it easily.

Look how easy it is to use:

import project
# Get your stuff done
project.do_stuff()

Features

  • Be awesome
  • Make things faster

Installation

Install $project by running:

install project

Contribute

  • Issue Tracker: github.com/$project/$project/issues
  • Source Code: github.com/$project/$project

Support

If you are having issues, please let us know. We have a mailing list located at: [email protected]

License

The project is licensed under the BSD license.