Skip to content

Commit

Permalink
Link to the tutorial notebooks more prominently.
Browse files Browse the repository at this point in the history
  • Loading branch information
timstaley committed Apr 21, 2016
1 parent ebff38d commit fefbccc
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 2 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ An introduction may be found in the
[online documentation](http://voevent-parse.readthedocs.org),
or in raw form [here](documentation/source/index.rst).

Alternatively you may want to jump right in and get started with
the accompanying
[tutorial notebooks](https://github.com/timstaley/voevent-parse-tutorial).

If you make use of *voevent-parse* in work leading to a publication, we ask
that you cite the [ASCL entry](http://ascl.net/1411.003).

7 changes: 7 additions & 0 deletions documentation/source/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,13 @@
Usage examples
==============

.. note::
See also the `tutorial notebooks`_, which give a step-by-step introduction
to using voevent-parse.

.. _tutorial notebooks: https://github.com/timstaley/voevent-parse-tutorial


Basic data access and manipulation
-----------------------------------

Expand Down
4 changes: 2 additions & 2 deletions documentation/source/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,8 @@ lxml.objectify 'gotchas'
------------------------

.. note::
See the `tutorial <https://github.com/timstaley/voevent-parse-tutorial>`_
for a basic introduction to lxml.objectify.
See also the `tutorial <https://github.com/timstaley/voevent-parse-tutorial>`_,
which includes a basic introduction to lxml.objectify.

The objectify library has a few syntactic quirks which can trip up new users.
Firstly, you should be aware that the line ``root.foo`` actually returns
Expand Down

0 comments on commit fefbccc

Please sign in to comment.