Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
vyrjana committed Mar 23, 2023
1 parent 54754d7 commit 24c36e9
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,13 @@ The primary interface for using DearEIS is a graphical user interface (GUI).
:alt: The graphical user interface of DearEIS


.. only:: html

.. note::

PDF copies of the documentation are available in the `releases section <https://github.com/vyrjana/DearEIS/releases>`_.


The GUI can be started via the following command:

.. code:: bash
Expand All @@ -61,7 +68,9 @@ An application programming interface (API) is also included and it can be used t
>>> import deareis


If you would prefer to primarily use an API or are looking for a command-line interface (CLI), then check out `pyimpspec <https://vyrjana.github.io/pyimpspec>`_.
.. note::

If you would prefer to primarily use an API or are looking for a command-line interface (CLI), then check out `pyimpspec <https://vyrjana.github.io/pyimpspec>`_.

The source code for DearEIS can be found `here <https://github.com/vyrjana/DearEIS>`_.
The changelog can be found `here <https://github.com/vyrjana/DearEIS/blob/main/CHANGELOG.md>`_.
Expand All @@ -70,10 +79,6 @@ If you wish to contribute to the project, then please read the `readme <https://

DearEIS is licensed under GPLv3_ or later.

.. only:: html

PDF copies of the documentation are available in the `releases section <https://github.com/vyrjana/DearEIS/releases>`_.


.. toctree::
:maxdepth: 2
Expand Down

0 comments on commit 24c36e9

Please sign in to comment.