Instructions for using this template

1. Can create an empty repository for your new project e.g. on github.
2. Clone it to your local hdd.
3. Download the code in this repository as a zip file (ie don't clone the code, use the code download button e.g. on github click the green button and select the download option. This will will zip the entire repository with only the latest source files).
4. Extract the zip into your cloned repository.
5. Commit the extracted files to your new repository.

DELETE THIS LINE AND ALL TEXT ABOVE

Your repository name

Python module for ... See the documentation for more information.

Dependencies

See requirements.txt for python dependencies. The python module named parameterized is used for testing.

Accessing documentation

The documentation is hosted on Readthedocs - add link

The documentation is hosted on an ABI webserver that is accessible only within the university or via VPN - add link

Building documentation locally

From the terminal

1. Clone the repository to your local machine.

2. Install dependencies by pip install -r requirements.txt

3. Navigate to the docs/

4. Issue the command: make html. If you get an error saying "Pandoc is missing", you might need to install Pandoc separately by "sudo apt-get install pandoc"

5. Open the index.html file in docs/build/ folder

See the following instructions for more information regarding updating documentation.

Contributing to documentation

Updating the documentation

1. Fork this repository from an upstream repository to your github account (An Upstream repository is the Parent/Original repository from where you forked your repository)

2. Edit the restructuredText (.rst) or markdown (.md) files in the docs/sources folder (editing of these files can performed directly using the file editing tools provided by github. This will allow you to commit your changes to the repository.

3. Make a pull request from your fork to the master branch of the Upstream repository.

4. Your changes will be reviewed and pulled into the Upstream repository.

Over time, your fork may become out of sync with the master branch of the Upstream repository. Create a pull request on your fork to pull in the latest changes from the master branch of the Upstream repository to get your fork back up-to-date. This can be performed directly on the github website.