Skip to content

Commit

Permalink
Tweak home and dev docs pages
Browse files Browse the repository at this point in the history
  • Loading branch information
iskandergaba committed Oct 25, 2024
1 parent 3df75cf commit e794f11
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 8 deletions.
11 changes: 4 additions & 7 deletions docs/dev.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,28 +4,25 @@ Development
This project is built and published using `Poetry <https://python-poetry.org>`__. To setup a development environment for this project you can follow these steps:

1. Install `Poetry <https://python-poetry.org/docs/#installing-with-pipx>`__.
2. Navigate to the root folder and install dependencies in a virtual environment:
2. Navigate to the root folder and setup the virtual environment:

.. code:: shell
poetry install
3. If everything worked properly, you should have an environment under
the name ``pyriodicity-py3.*`` activated. You can verify this by
running:
3. You should have the development environment activated now. Verify that you have an environment name starting with ``pyriodicity-py3`` by running:

.. code:: shell
poetry env list
4. You can run tests using the command:
4. Run the unit tests using the command:

.. code:: shell
poetry run pytest
5. To export the detailed dependency list, consider running the
following:
5. To export the detailed dependency list, run the following:

.. code:: shell
Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Pyriodicity

|PyPI - Python Version| |GitHub License| |CI Build| |Codecov|

Pyriodicity provides intuitive and easy-to-use Python implementation for periodicity detection in univariate signals.
Pyriodicity provides an intuitive and easy-to-use Python implementation for periodicity detection in univariate signals.

.. raw:: html

Expand Down

0 comments on commit e794f11

Please sign in to comment.