Skip to content

Commit

Permalink
Rename tutorial to how_to_install and example to how_to_parse, and re…
Browse files Browse the repository at this point in the history
…build files
  • Loading branch information
langner committed Aug 27, 2017
1 parent a03ee03 commit 632ea6a
Show file tree
Hide file tree
Showing 31 changed files with 454 additions and 299 deletions.
4 changes: 2 additions & 2 deletions _sources/contents.txt
Expand Up @@ -7,14 +7,14 @@ Table of Contents
:maxdepth: 2

index
tutorial
how_to_install
how_to_parse
data
data_notes
methods
development
data_dev
changelog
examples

Indices and tables
==================
Expand Down
128 changes: 65 additions & 63 deletions _sources/coverage_dev.txt

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions _sources/development.txt
Expand Up @@ -5,9 +5,9 @@ Development
Basic instructions
===========================

The default cclib files distributed with a release, as described in the `tutorial`_, do not include any unit tests and logfiles necessary to run those tests. This section covers how to download the full source along with all test data and scripts, and how to use these for development and testing.
The default cclib files distributed with a release, as described in `How to install`_, do not include any unit tests and logfiles necessary to run those tests. This section covers how to download the full source along with all test data and scripts, and how to use these for development and testing.

.. _`tutorial`: tutorial.html
.. _`How to install`: how_to_install.html

Cloning cclib from GitHub
~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
4 changes: 2 additions & 2 deletions _sources/tutorial.txt → _sources/how_to_install.txt
@@ -1,5 +1,5 @@
Tutorial
========
How to install
==============

This page describes how to download, install and use the basic functionality of cclib.

Expand Down
4 changes: 2 additions & 2 deletions _sources/examples.txt → _sources/how_to_parse.txt
@@ -1,5 +1,5 @@
Examples
========
How to parse and write
======================

The cclib package provides three scripts to parse and write data i.e. ``ccget``, ``ccwrite``, and ``cda``

Expand Down
4 changes: 2 additions & 2 deletions _sources/index.txt
Expand Up @@ -32,7 +32,7 @@ Many types of output data are parsed by cclib, including atom coordinates, orbit
How to use cclib
----------------

You can download the `source package for cclib 1.5`_ or the `current development version`_ (from the `GitHub repository`_). For information on packages available in various Linux distributions, installing the source code and requirements, as well as basic usage, the tutorial_ is a good place to start.
You can download the `source package for cclib 1.5`_ or the `current development version`_ (from the `GitHub repository`_). For information on packages available in various Linux distributions, installing the source code and requirements, as well as basic usage, the `How to install`_ is a good place to start.

If you need further help, find a bug, need new features or have any question, please send email to the `mailing list`_ or submit an issue to the `tracker`_.

Expand All @@ -56,7 +56,7 @@ A record for the latest release is also available on Zenodo_.
.. _`extracted data`: data.html
.. _`calculation methods`: methods.html
.. _`installation page`: installation.html
.. _tutorial: tutorial.html
.. _`How to install`: how_to_install.html
.. _development: development.html

.. _ADF: https://www.scm.com/product/adf/
Expand Down
6 changes: 3 additions & 3 deletions attributes.html
Expand Up @@ -81,14 +81,14 @@

<ul>
<li class="toctree-l1"><a class="reference internal" href="index.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="how_to_install.html">How to install</a></li>
<li class="toctree-l1"><a class="reference internal" href="how_to_parse.html">How to parse and write</a></li>
<li class="toctree-l1"><a class="reference internal" href="data.html">Parsed data (version 1.5)</a></li>
<li class="toctree-l1"><a class="reference internal" href="data_notes.html">Parsed data notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="methods.html">Calculation methods</a></li>
<li class="toctree-l1"><a class="reference internal" href="development.html">Development</a></li>
<li class="toctree-l1"><a class="reference internal" href="data_dev.html">Development parsed data</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
</ul>


Expand Down Expand Up @@ -508,4 +508,4 @@


</body>
</html>
</html>
6 changes: 3 additions & 3 deletions attributes_dev.html
Expand Up @@ -81,14 +81,14 @@

<ul>
<li class="toctree-l1"><a class="reference internal" href="index.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="how_to_install.html">How to install</a></li>
<li class="toctree-l1"><a class="reference internal" href="how_to_parse.html">How to parse and write</a></li>
<li class="toctree-l1"><a class="reference internal" href="data.html">Parsed data (version 1.5)</a></li>
<li class="toctree-l1"><a class="reference internal" href="data_notes.html">Parsed data notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="methods.html">Calculation methods</a></li>
<li class="toctree-l1"><a class="reference internal" href="development.html">Development</a></li>
<li class="toctree-l1"><a class="reference internal" href="data_dev.html">Development parsed data</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
</ul>


Expand Down Expand Up @@ -513,4 +513,4 @@


</body>
</html>
</html>
9 changes: 3 additions & 6 deletions changelog.html
Expand Up @@ -31,7 +31,6 @@


<link rel="top" title="cclib 1.5 documentation" href="index.html"/>
<link rel="next" title="Examples" href="examples.html"/>
<link rel="prev" title="Development parsed data" href="data_dev.html"/>


Expand Down Expand Up @@ -83,7 +82,8 @@

<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="index.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="how_to_install.html">How to install</a></li>
<li class="toctree-l1"><a class="reference internal" href="how_to_parse.html">How to parse and write</a></li>
<li class="toctree-l1"><a class="reference internal" href="data.html">Parsed data (version 1.5)</a></li>
<li class="toctree-l1"><a class="reference internal" href="data_notes.html">Parsed data notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="methods.html">Calculation methods</a></li>
Expand All @@ -109,7 +109,6 @@
<li class="toctree-l2"><a class="reference internal" href="#changes-in-cclib-0-5">Changes in cclib-0.5</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
</ul>


Expand Down Expand Up @@ -524,8 +523,6 @@ <h2>Changes in cclib-0.5<a class="headerlink" href="#changes-in-cclib-0-5" title

<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">

<a href="examples.html" class="btn btn-neutral float-right" title="Examples" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a>


<a href="data_dev.html" class="btn btn-neutral" title="Development parsed data" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a>

Expand Down Expand Up @@ -586,4 +583,4 @@ <h2>Changes in cclib-0.5<a class="headerlink" href="#changes-in-cclib-0-5" title


</body>
</html>
</html>
26 changes: 13 additions & 13 deletions contents.html
Expand Up @@ -82,14 +82,14 @@

<ul>
<li class="toctree-l1"><a class="reference internal" href="index.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="how_to_install.html">How to install</a></li>
<li class="toctree-l1"><a class="reference internal" href="how_to_parse.html">How to parse and write</a></li>
<li class="toctree-l1"><a class="reference internal" href="data.html">Parsed data (version 1.5)</a></li>
<li class="toctree-l1"><a class="reference internal" href="data_notes.html">Parsed data notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="methods.html">Calculation methods</a></li>
<li class="toctree-l1"><a class="reference internal" href="development.html">Development</a></li>
<li class="toctree-l1"><a class="reference internal" href="data_dev.html">Development parsed data</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
</ul>


Expand Down Expand Up @@ -144,11 +144,16 @@
<li class="toctree-l2"><a class="reference internal" href="index.html#about-cclib">About cclib</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial</a><ul>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#requirements">Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#debian-gnu-linux-systems">Debian GNU/Linux systems</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#manual-download-and-install">Manual download and install</a></li>
<li class="toctree-l2"><a class="reference internal" href="tutorial.html#what-next">What next?</a></li>
<li class="toctree-l1"><a class="reference internal" href="how_to_install.html">How to install</a><ul>
<li class="toctree-l2"><a class="reference internal" href="how_to_install.html#requirements">Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="how_to_install.html#debian-gnu-linux-systems">Debian GNU/Linux systems</a></li>
<li class="toctree-l2"><a class="reference internal" href="how_to_install.html#manual-download-and-install">Manual download and install</a></li>
<li class="toctree-l2"><a class="reference internal" href="how_to_install.html#what-next">What next?</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="how_to_parse.html">How to parse and write</a><ul>
<li class="toctree-l2"><a class="reference internal" href="how_to_parse.html#ccget">ccget</a></li>
<li class="toctree-l2"><a class="reference internal" href="how_to_parse.html#ccwrite">ccwrite</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="data.html">Parsed data (version 1.5)</a><ul>
Expand Down Expand Up @@ -238,11 +243,6 @@
<li class="toctree-l2"><a class="reference internal" href="changelog.html#changes-in-cclib-0-5">Changes in cclib-0.5</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a><ul>
<li class="toctree-l2"><a class="reference internal" href="examples.html#ccget">ccget</a></li>
<li class="toctree-l2"><a class="reference internal" href="examples.html#ccwrite">ccwrite</a></li>
</ul>
</li>
</ul>
</div>
</div>
Expand Down Expand Up @@ -320,4 +320,4 @@ <h1>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Pe


</body>
</html>
</html>
6 changes: 3 additions & 3 deletions coverage.html
Expand Up @@ -81,14 +81,14 @@

<ul>
<li class="toctree-l1"><a class="reference internal" href="index.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial.html">Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="how_to_install.html">How to install</a></li>
<li class="toctree-l1"><a class="reference internal" href="how_to_parse.html">How to parse and write</a></li>
<li class="toctree-l1"><a class="reference internal" href="data.html">Parsed data (version 1.5)</a></li>
<li class="toctree-l1"><a class="reference internal" href="data_notes.html">Parsed data notes</a></li>
<li class="toctree-l1"><a class="reference internal" href="methods.html">Calculation methods</a></li>
<li class="toctree-l1"><a class="reference internal" href="development.html">Development</a></li>
<li class="toctree-l1"><a class="reference internal" href="data_dev.html">Development parsed data</a></li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples</a></li>
</ul>


Expand Down Expand Up @@ -994,4 +994,4 @@


</body>
</html>
</html>

0 comments on commit 632ea6a

Please sign in to comment.