Skip to content

Commit

Permalink
Merge pull request cta-observatory#2330 from cta-observatory/fix_docs…
Browse files Browse the repository at this point in the history
…_links

Fix links to docs
  • Loading branch information
maxnoe authored May 12, 2023
2 parents 8ff0ee3 + 54a17c8 commit fe16afa
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -71,11 +71,11 @@ or via::

pip install ctapipe

**Note**: to install a specific version of ctapipe take look at the documentation `here <https://cta-observatory.github.io/ctapipe/getting_started_users>`__.
**Note**: to install a specific version of ctapipe take look at the documentation `here <https://ctapipe.readthedocs.org/en/latest/getting_started_users/>`__.

**Note**: ``mamba`` is a C++ reimplementation of conda and can be found `here <https://github.com/mamba-org/mamba>`__.

Note this is *pre-alpha* software and is not yet stable enough for end-users (expect large API changes until the first stable 1.0 release).

Developers should follow the development install instructions found in the
`documentation <https://cta-observatory.github.io/ctapipe/getting_started>`__.
`documentation <https://ctapipe.readthedocs.org/en/latest/getting_started/>`__.
8 changes: 4 additions & 4 deletions docs/getting_started/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@
Getting Started For Developers
******************************

We strongly recommend using the `mambaforge conda distribution <https://github.com/conda-forge/miniforge#mambaforge>`_.

.. warning::

the following guide is used only if you want to *develop* the
``ctapipe`` package, if you just want to write code that uses it
externally, you can install ``ctapipe`` as a conda package
with ``conda install -c conda-forge ctapipe``.
with ``mamba install -c conda-forge ctapipe``.

This guide assumes you are using the *Anaconda* python distribution,
installed locally (*miniconda* should also work).

You can use *python 3.7* or above (we currently test on 3.7 and 3.8)
You can use |python_requires| or above.

------------------------
Get the ctapipe software
Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ What is ctapipe?
the 1.0 release.

* Code, feature requests, bug reports, pull requests: https://github.com/cta-observatory/ctapipe
* Docs: https://cta-observatory.github.io/ctapipe/
* Docs: https://ctapipe.readthedocs.io/
* License: BSD-3
* Python: |python_requires|

Expand Down

0 comments on commit fe16afa

Please sign in to comment.