Skip to content

Commit

Permalink
Added proper hyperlinks to index
Browse files Browse the repository at this point in the history
  • Loading branch information
mcgibbon committed Nov 27, 2018
1 parent a2b454c commit f97e211
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
5 changes: 4 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,15 @@ models in Python. It is meant to be used in combination with other packages
that provide model components in order to write model scripts. Its source
code can be found on GitHub_.

New users should read the quickstart_. This framework is meant to be used along
New users should read the :ref:`quickstart`. This framework is meant to be used along
with model toolkits like CliMT_ to write models. See the paper_ on Sympl and
CliMT for a good overview and some examples! You may also want to check out the
`CliMT documentation`_.

.. _GitHub: https://github.com/mcgibbon/sympl
.. _paper: https://www.geosci-model-dev.net/11/3781/2018/gmd-11-3781-2018.html
.. _`CliMT documentation`: https://climt.readthedocs.io/en/latest/
.. _CliMT: https://github.com/climt/climt

Documentation
-------------
Expand Down
2 changes: 2 additions & 0 deletions docs/quickstart.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _quickstart:

==========
Quickstart
==========
Expand Down

0 comments on commit f97e211

Please sign in to comment.