gh-pages
|
Last change
on this file since d1fe925 was
d1fe925,
checked in by ajj, 8 years ago
|
|
Creating gh_pages branch for docs
|
-
Property mode set to
100644
|
|
File size:
854 bytes
|
| Line | |
|---|
| 1 | This is the top level build direcgtory for the periodictable |
|---|
| 2 | documentation. All of the documentation is written using |
|---|
| 3 | sphinx, a python documentation system using restructured text. |
|---|
| 4 | |
|---|
| 5 | See the User Guide section "Contributing Changes" for details |
|---|
| 6 | on how to build the documentation. |
|---|
| 7 | |
|---|
| 8 | Manifest: |
|---|
| 9 | |
|---|
| 10 | Makefile use "make clean html pdf" to build the docs |
|---|
| 11 | guide user documentation |
|---|
| 12 | api auto-generated interface documentation |
|---|
| 13 | plots programs to generate figures |
|---|
| 14 | index.rst top level include document |
|---|
| 15 | genmods.py creates the module index files |
|---|
| 16 | conf.py sphinx configuration |
|---|
| 17 | rst_prolog restructured text macros (for units) |
|---|
| 18 | discoverer, |
|---|
| 19 | shelltable sample extensions |
|---|
| 20 | _static images and style sheets |
|---|
| 21 | _templates page layouts |
|---|
| 22 | _extensions sphinx extensions |
|---|
| 23 | _build output directory |
|---|
Note: See
TracBrowser
for help on using the repository browser.
