ASE Manual Release 3.6.1.2825 CAMd - CampOS Wiki
ASE Manual Release 3.6.1.2825 CAMd - CampOS Wiki
ASE Manual Release 3.6.1.2825 CAMd - CampOS Wiki
Create successful ePaper yourself
Turn your PDF publications into a flip-book with our unique Google optimized e-Paper software.
Installing Docutils and Sphinx<br />
<strong>ASE</strong> <strong>Manual</strong>, <strong>Release</strong> 3.6.1.2828<br />
The reStructuredText parser that Sphinx needs, is part of the Docutils project. So, we need to install docutils and<br />
sphinx (version>= 0.5).<br />
Other requirements<br />
When building the documentation, a number of png-files are generated. For that to work, you need the following<br />
installed:<br />
• matplotlib<br />
• povray<br />
• dvipng<br />
• pdflatex<br />
• bibtex<br />
• AUCTex<br />
• convert (ImageMagick)<br />
Using Sphinx<br />
First, you should take a look at the documentation for Sphinx and reStructuredText.<br />
If you don’t already have your own copy of the <strong>ASE</strong> package, then get the Latest development release and install<br />
it.<br />
Then cd to the doc directory and build the html-pages:<br />
$ cd ~/ase/doc<br />
$ sphinx-build . _build<br />
Note: Make sure that you build the Sphinx documentation using the corresponding <strong>ASE</strong> version by setting the<br />
environment variables $PYTHONPATH and $PATH.<br />
Make your changes to the .rst files, run the sphinx-build command again, check the results and if things looks<br />
ok, commit:<br />
$ emacs index.rst<br />
$ sphinx-build . _build<br />
$ firefox _build/index.html<br />
$ svn ci -m "..." index.rst<br />
To build a pdf-file, you do this:<br />
$ sphinx-build -b latex . _build<br />
$ cd _build<br />
$ make ase-manual.pdf<br />
Extensions to Sphinx<br />
We have a couple of extensions to Sphinx:<br />
:mol:<br />
:svn:<br />
Use :mol:‘CH_3OH‘ to get CH3OH.<br />
11.1. Development topics 191
Change language