NCSA External Code Reference Page¶
Contents:
Installation¶
Install the package with pip:
$ pip install read-the-docs-template
Template¶
Note: This template is not maintained anymore, use the tutorial 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: project@google-groups.com
License¶
The project is licensed under the BSD license.
Usage¶
To use this template, simply update it:
import read-the-docs-template
This page tree contains reference pages for applications that were developed externally to NCSA, but that we have used on our systems enough that we have reference documents for building and/or installing on our systems. These pages are generally not to document the codes themselves (we assume they have their own documentation elsewhere), but to document how we installed them, or how users could get access to them.
Some of these pages are current, but many of them arent, and are placed here as historical reference. Each code page should have information at the top with the last time it was modified and if it’s up to date on any current NCSA sytems.