Skip to content
This repository has been archived by the owner on Dec 22, 2021. It is now read-only.

Commit

Permalink
Starting porting docs toc to front page
Browse files Browse the repository at this point in the history
  • Loading branch information
@leouieda
leouieda committed Dec 8, 2015
1 parent f1dcead commit 7418c33
Show file tree
Hide file tree
Showing 2 changed files with 172 additions and 124 deletions.
102 changes: 35 additions & 67 deletions doc/docs.rst
View file
Original file line number Diff line number Diff line change
@@ -1,90 +1,58 @@
.. _docs:

Documentation
=============

Previous versions
-----------------

Source code snapshots of each release of Fatiando a Terra are archived in
`Zenodo <http://zenodo.org/>`__ or
`figshare <http://figshare.com/>`__.
We also preseve a built version of the documentation for reference.

.. raw:: html

<div class="alert alert-success">
<h4>Important</h4>

Refer to the **latest build** of the docs for more up-to-date information.
It reflects the *master* branch `on Github
<https://github.com/fatiando/fatiando>`__.

.. raw:: html

</div>
Documentation (version |version|)
===================================

.. raw:: html

<div class="container-fluid">
<div class="row">

.. raw:: html
<div class="col-md-3">
<h3><a href="api/fatiando.html">Library reference</a></h3>

<div class="col-md-4">
<h3>Version 0.3</h3>
The modules and packages of the
<code class="docutils literal">fatiando</code> package.
</div>

* `Documentation <http://fatiando.github.io/v0.3/>`__
* `Source code <https://github.com/fatiando/fatiando/tree/v0.3>`__
* doi:`10.5281/zenodo.16205 <http://dx.doi.org/10.5281/zenodo.16205>`__
<div class="col-md-3">
<h3>Cookbook</h3>
</div>

.. raw:: html
<div class="col-md-3">
<h3><a href="cite.html">Citing</a></h3>
</div>

</div>
<div class="col-md-3">
<h3><a href="develop.html">Developer Guide</a></h3>

.. raw:: html

<div class="col-md-4">
<h3>Version 0.2</h3>

* `Documentation <http://fatiando.github.io/v0.2/>`__
* `Source code <https://github.com/fatiando/fatiando/tree/v0.2>`__
* doi:`10.6084/m9.figshare.1115194 <http://dx.doi.org/10.6084/m9.figshare.1115194>`__

.. raw:: html
Instructions for contributing to Fatiando.
</div>

</div>

.. raw:: html
<div class="row">

<div class="col-md-4">
<h3>Version 0.1</h3>
<div class="col-md-3">
<h3>Changelog</h3>
</div>

* `Documentation <http://fatiando.github.io/v0.1/>`__
* `Source code <https://github.com/fatiando/fatiando/tree/v0.1>`__
* doi:`10.5281/zenodo.16207 <http://dx.doi.org/10.5281/zenodo.16207>`__
<div class="col-md-3">
<h3>Contributors</h3>
</div>

.. raw:: html
<div class="col-md-3">
<h3>License</h3>
</div>

</div>

.. raw:: html
<div class="col-md-3">
</div>

</div>
</div>

Latest build
------------

.. toctree::
:maxdepth: 2

license.rst
cite.rst
changelog.rst
install.rst
api/fatiando.rst
develop.rst
contributors.rst
cookbook.rst
Other versions
--------------

* `Development version <http://www.fatiando.org/dev>`__
* `Version 0.3 (stable) <http://www.fatiando.org/v0.3>`__
* `Version 0.2 <http://www.fatiando.org/v0.2>`__
* `Version 0.1 <http://www.fatiando.org/v0.1>`__
194 changes: 137 additions & 57 deletions doc/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
.. raw:: html

<div class="row" style="margin-top: 60px">
<div class="col-md-2">
</div>
<div class="col-md-8">
<img src="_static/fatiando-banner-homepage.png" width="100%"
style="margin-bottom: 50px;"></img>
</div>
<div class="col-md-2">
</div>
<div class="col-md-2">
</div>
<div class="col-md-8">
<img src="_static/fatiando-banner-homepage.png" width="100%"
style="margin-bottom: 50px;"></img>
</div>
<div class="col-md-2">
</div>
</div>

<div class="text-center" style="font-size: 16pt; margin-bottom: 50px;">
Expand All @@ -25,9 +25,11 @@ for geophysical data analysis and the development of new methodologies.

</div>

<div class="container-fluid">
.. raw:: html

<div class="row">
<div class="col-md-4">

<div class="col-md-6">
<h2>Overview</h2>


Expand Down Expand Up @@ -55,7 +57,10 @@ documents. Great for teaching fundamental concepts of geophysics.
.. raw:: html

</div>
<div class="col-md-4">

.. raw:: html

<div class="col-md-6">
<h2>Getting started</h2>

See the :ref:`install instructions <install>` to set up your computer and
Expand All @@ -64,28 +69,25 @@ install Fatiando.
Once you have everything installed, browse the :ref:`cookbook <cookbook>`
for examples of what Fatiando can do.

If you have problems, don't hesitate to :ref:`get in touch <contact>`!
If you have problems, don't hesitate to
`get in touch <https://groups.google.com/d/forum/fatiando>`__!

.. raw:: html

<div class="alert alert-success">
<h4><strong>Support us!</strong></h4>
.. raw:: html

Fatiando is research software **made by scientists**.
Please :ref:`cite <cite>` it in your publications if you used it.
Citations help us justify the effort
that goes into building and maintenance.
</div>

.. raw:: html

</div>
</div><!-- Row -->

.. raw:: html

.. _contact:
<div class="row">

.. raw:: html

</div>
<div class="col-md-4">
<div class="col-md-6">
<h2>Getting help</h2>

There are many ways to get in contact with us:
Expand All @@ -103,10 +105,10 @@ full error message.
.. raw:: html

</div>
</div> <!-- row -->

<div class="row">
<div class="col-md-4">
.. raw:: html

<div class="col-md-6">
<h2>Contributing</h2>

**You don't need to code to contribute.**
Expand All @@ -131,26 +133,82 @@ Don't be afraid to ask for help getting started!
.. raw:: html

</div>
<div class="col-md-4">
<h2>Documentation</h2>

.. toctree::
:maxdepth: 1
</div> <!-- Row -->

install.rst
cookbook.rst
cite.rst
api/fatiando.rst
develop.rst
contributors.rst
changelog.rst
license.rst
news.rst
.. raw:: html

<div class="row">

<div class="col-md-12">

.. raw:: html

<h2>Documentation</h2>

<div class="col-md-12">
<div class="row">
<div class="col-md-3">
<h3><a href="install.html">Installing</a></h3>
<em>
</em>
</div>
<div class="col-md-3">
<h3><a href="api/fatiando.html">Library reference</a></h3>
<em>
The modules and packages of the
<code class="docutils literal">fatiando</code> package.
</em>
</div>
<div class="col-md-3">
<h3><a href="cookbook.html">Cookbook</a></h3>
<em>
</em>
</div>
<div class="col-md-3">
<h3><a href="cite.html">Citing</a></h3>
<em>
Fatiando is research software <strong>made by scientists</strong>.
See how to cite it in your publications.
</em>
</div>
</div>
<div class="row">
<div class="col-md-3">
<h3><a href="develop.html">Developer Guide</a></h3>
<em>
Instructions for contributing to Fatiando.
</em>
</div>
<div class="col-md-3">
<h3><a href="contributors.html">Contributors</a></h3>
<em>
</em>
</div>
<div class="col-md-3">
<h3><a href="changelog.html">Changelog</a></h3>
<em>
</em>
</div>
<div class="col-md-3">
<h3><a href="license.html">License</a></h3>
<em>
</em>
</div>
</div>
</div>

.. raw:: html

</div>
<div class="col-md-4">

</div><!-- Row -->

.. raw:: html

<div class="row">

<div class="col-md-6">
<h2>Announcements</h2>

* **October 2014**: Fatiando was featured on volume 89 of the bulletin of the
Expand All @@ -170,33 +228,55 @@ Don't be afraid to ask for help getting started!

Read :ref:`all announcements <news>`.

.. raw:: html

</div>

.. raw:: html

<div class="col-md-6">
<h2>Other versions</h2>

* `Development version <http://www.fatiando.org/dev>`__
* `Version 0.3 (stable) <http://www.fatiando.org/v0.3>`__
* `Version 0.2 <http://www.fatiando.org/v0.2>`__
* `Version 0.1 <http://www.fatiando.org/v0.1>`__

.. raw:: html

</div>
</div> <!-- row -->

.. raw:: html


<div class="row" style="margin-top: 50px;">
<div class="col-md-3">
</div>
<div class="col-md-6">
<div class="text-center" style="margin-bottom: 20px;">
Watch Leo give a presentation about Fatiando at Scipy 2013.
<div class="col-md-3">
</div>
<div class="responsive-embed">
<iframe width="100%" height="400"
src="https://www.youtube.com/embed/Ec38h1oB8cc" frameborder="0"
allowfullscreen></iframe>
<div class="col-md-6">
<div class="text-center" style="margin-bottom: 20px;">
Watch Leo give a presentation about Fatiando at Scipy 2013.
</div>
<div class="responsive-embed">
<iframe width="100%" height="400"
src="https://www.youtube.com/embed/Ec38h1oB8cc" frameborder="0"
allowfullscreen></iframe>
</div>
</div>
<div class="col-md-3">
</div>
</div>
<div class="col-md-3">
</div>
</div>

</div>


.. toctree::
:maxdepth: 1
:maxdepth: 2
:hidden:

docs.rst
news.rst
license.rst
cite.rst
changelog.rst
install.rst
api/fatiando.rst
develop.rst
contributors.rst
cookbook.rst

0 comments on commit 7418c33

Please sign in to comment.