File: README.md

package info (click to toggle)
cclib 1.8.1-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 55,412 kB
  • sloc: python: 23,605; makefile: 75; sh: 31
file content (7 lines) | stat: -rw-r--r-- 713 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
# Documentation for cclib

This directory contains the source of the current official website and documentation for [cclib](https://github.com/cclib/cclib), available on GitHub pages at http://cclib.github.io.

## How to update documentation

The website is generated using [Sphinx](http://sphinx-doc.org/) with some [custom adjustments](https://github.com/cclib/sphinx_rtd_theme/tree/cclib). The [reStructuredText](http://sphinx-doc.org/rest.html) sources are in the `sphinx` subdirectory, and executing `make` places the built website in `sphinx/_build/html`. 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.