Skip to content

Commit

Permalink
Typo fix in optional dependency install and consolidate to bash synta…
Browse files Browse the repository at this point in the history
…x rather than a mix of zsh sytnax.
  • Loading branch information
jatkinson1000 committed Jan 23, 2025
1 parent 599cb5c commit e92023b
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 5 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,11 @@ It is recommended to use a virtual environment.
If you want a local install that you can edit instead, clone the repository,
navigate to `archeryutils/`, and run:

python3 -m pip install -e .[test,lint,docs]
python3 -m pip install -e .

Please refer to the online documentation for
[full installation guidance](https://archeryutils.readthedocs.io/en/latest/getting-started/installation.html).
[full installation guidance](https://archeryutils.readthedocs.io/en/latest/getting-started/installation.html)
including optional dependencies for developing and testing.

### Getting Started
There are examples of some of the different functionalities in the jupyter notebook
Expand Down
8 changes: 5 additions & 3 deletions docs/getting-started/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,15 @@ install as an editable package::

git clone [email protected]:jatkinson1000/archeryutils.git
cd archeryutils
pip install -e .[test,int,docs]
pip install -e .[test,lint,docs]

Testing
~~~~~~~

To run tests on a development installation either install
`pytest <https://docs.pytest.org/>`__ using pip, or install as an optional dependency::

pip install -e ".[test]"
pip install -e .[test]

and then run::

Expand All @@ -54,6 +54,8 @@ lint

For applying quality control to the code::

pip install -e .[lint]

* ruff (0.7.3 or later)
* mypy (1.0.0 or later)
* coverage
Expand All @@ -66,7 +68,7 @@ docs

For building documentation::

pip install -e ".[docs]"
pip install -e .[docs]

* sphinx
* sphinx_rtd_theme
Expand Down

0 comments on commit e92023b

Please sign in to comment.