Skip to content

Commit

Permalink
DOC: adding updates to source install docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bsipocz committed Feb 28, 2023
1 parent 76d4130 commit 01e0474
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ or cloned and installed from source:
$ # If you do not:
$ git clone https://github.com/astropy/astroquery.git
$ cd astroquery
$ python setup.py install
$ pip install .
Using astroquery
----------------
Expand Down
17 changes: 16 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,22 @@ The development version can be obtained and installed from github:
$ # If you do not:
$ git clone https://github.com/astropy/astroquery.git
$ cd astroquery
$ python setup.py install
$ pip install .
To install all the optional dependencies (listed below), add the option
``[all]``. To install dependencies required for running the tests locally
use ``[test]``, and for documentation build ``[docs]``.
If you would like to modify the source, you can install
``astroquery`` in editable mode, which means you don't need to rerun the
install command after you made the changes.

To install all dependencies, including those required for local testing and
building the documentation, in editable mode:

..code-block:: bash

$ pip install -e .[all,test,docs]


Requirements
Expand Down

0 comments on commit 01e0474

Please sign in to comment.