Skip to content

Commit

Permalink
corrected docs internal links
Browse files Browse the repository at this point in the history
  • Loading branch information
bonfus committed May 27, 2017
1 parent aa67412 commit 4eb56ac
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 7 deletions.
2 changes: 2 additions & 0 deletions docs/Examples.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.. _examples:

Examples
========

Expand Down
4 changes: 1 addition & 3 deletions docs/Install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -93,10 +93,8 @@ Muesr functions you also need `spglib` and `PyYAML` ::
pip install pyyaml spglib

Now you are ready to go! Why not start with a look at the first paragraph of the Tutorial_ and then move directly to the Muesr Examples_?
Now you are ready to go! Why not start with a look at the first paragraph of the :ref:`tutorial` and then move directly to the Muesr :ref:`examples`?

.. _Tutorial: ../html/Tutorial.html
.. _Examples: ../html/Examples.html



9 changes: 5 additions & 4 deletions docs/Tutorial.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
.. _tutorial:


Tutorial
========

Expand All @@ -14,8 +17,7 @@ To use :py:mod:`~muesr` you must be familiar with python. An interactive shell l
To be pedantic, you can

1. Run the commands listed below in an ipython console
2. Write these commands in a example.py file and run by the command ::
python example.py
2. Write these commands in a example.py file and run it with python
3. Use the muesr gui (which implies having what?)
4. Use `Mantid <https://www.mantidproject.org/Main_Page>`_, that contains a muesr library

Expand All @@ -24,9 +26,8 @@ To be pedantic, you can

First steps with muesr
---------------------------
Find below a tutorial description of the main functions. An alternative way to familiarise with muer is to run directly the examples_ first and then come back here for a more systematic introduction.
Find below a tutorial description of the main functions. An alternative way to familiarise with muer is to run directly the :ref:`examples` first and then come back here for a more systematic introduction.

.. _examples: ../html/Examples.html

Defining the sample
+++++++++++++++++++++++++++++++++
Expand Down

0 comments on commit 4eb56ac

Please sign in to comment.