/cclib.github.io

Pages for cclib

Primary LanguageHTMLGNU Lesser General Public License v2.1LGPL-2.1

Documentation for cclib

This repository contains the source and contents of the current official website and documentation for cclib, available on GitHub pages at http://cclib.github.io.

How to update documentation

The website is generated using Sphinx (preferred version is currently 1.2) with some custom adjustments. The top level directory contains the website (including index.html), and the reStructuredText sources are in the sphinx subdirectory. Some of the content is generated automatically from the cclib code using autodoc or custom Python scripts, and this should be handled by the Makefile. Therefore, it is normally quite straightforward for developers to add content or update the website:

$ git pull git@github.com:cclib/cclib.github.io.git
... some output ...
$ cd cclib.github.io/sphinx
$ vi changelog.rst
$ make
... lots of output ...
$ git status
... inspect changes ...
$ git commit -a -m "Update docs"
...
$ git push

For larger changes, it is also acceptable to fork this repository and submit a pull request.