Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Typo fix in optional dependency install docs #114

Merged
merged 2 commits into from
Jan 23, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
15 changes: 12 additions & 3 deletions docs/getting-started/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,15 +27,22 @@ 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]

.. note::
If you are installing in zsh you will need to use quotes for the optional dependencies:

.. code-block:: bash

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 +61,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 +75,7 @@ docs

For building documentation::

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

* sphinx
* sphinx_rtd_theme
Expand Down
Loading