Skip to content

Commit 01e0474

Browse files
committed
DOC: adding updates to source install docs
1 parent 76d4130 commit 01e0474

File tree

2 files changed

+17
-2
lines changed

2 files changed

+17
-2
lines changed

README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ or cloned and installed from source:
8686
$ # If you do not:
8787
$ git clone https://github.com/astropy/astroquery.git
8888
$ cd astroquery
89-
$ python setup.py install
89+
$ pip install .
9090
9191
Using astroquery
9292
----------------

docs/index.rst

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,22 @@ The development version can be obtained and installed from github:
7474
$ # If you do not:
7575
$ git clone https://github.com/astropy/astroquery.git
7676
$ cd astroquery
77-
$ python setup.py install
77+
$ pip install .
78+
79+
80+
To install all the optional dependencies (listed below), add the option
81+
``[all]``. To install dependencies required for running the tests locally
82+
use ``[test]``, and for documentation build ``[docs]``.
83+
If you would like to modify the source, you can install
84+
``astroquery`` in editable mode, which means you don't need to rerun the
85+
install command after you made the changes.
86+
87+
To install all dependencies, including those required for local testing and
88+
building the documentation, in editable mode:
89+
90+
..code-block:: bash
91+
92+
$ pip install -e .[all,test,docs]
7893

7994

8095
Requirements

0 commit comments

Comments
 (0)