Skip to content

Commit e9a78c0

Browse files
committed
update readthedocs yaml
1 parent 14152d3 commit e9a78c0

File tree

2 files changed

+10
-8
lines changed

2 files changed

+10
-8
lines changed

.readthedocs.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,6 @@ formats:
2222
python:
2323
install:
2424
- requirements: readthedocs-requirements.txt
25-
- method: setuptools
25+
- method: pip
2626
path: .
2727

docs/source/getting-started.rst

+9-7
Original file line numberDiff line numberDiff line change
@@ -6,29 +6,31 @@ Getting started
66
Installation
77
^^^^^^^^^^^^^^^^
88

9-
``GGLasso`` is available over Pypi or `Github`_. For installation with pip, simply run
9+
The official repository can be found on `Github`_
10+
``GGLasso`` is available over ``pip`` and ``conda``. For installation from PyPi, simply run
1011

1112
.. code-block::
1213
1314
pip install gglasso
1415
15-
To install from source, clone the repository and make sure you have all requirements installed. Then move to the directory and run
16+
For ``conda``, use
1617

1718
.. code-block::
1819
19-
python setup.py
20+
conda install -c conda-forge gglasso
2021
21-
This installs a package called ``gglasso`` in your Python environment. In case you want to edit the source code and use the ``gglasso`` package without re-installing, you can run instead
22+
Alternatively, you can clone from Github and install a developer version with the command
2223

2324
.. code-block::
2425
25-
python setup.py clean --all develop clean --all
26+
python -m pip install --editable .
2627
27-
To make sure that everything works properly you can run unit tests in ``gglasso/tests``, for example
28+
29+
To make sure that everything works properly you can run unit tests with
2830

2931
.. code-block::
3032
31-
pytest gglasso/ -v
33+
pytest tests/ -v
3234
3335
To import from ``GGLasso`` in Python, type for example
3436

0 commit comments

Comments
 (0)