Skip to content

Commit

Permalink
Updated README for new optional dependencies
Browse files Browse the repository at this point in the history
  • Loading branch information
Sebastian Luque committed Oct 3, 2023
1 parent f68ce07 commit be8c656
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 8 deletions.
10 changes: 3 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.. image:: docs/source/.static/skdiveMove_logo_1line.png
.. image:: https://raw.githubusercontent.com/spluque/scikit-diveMove/master/docs/source/.static/skdiveMove_logo_1line.png
:target: https://github.com/spluque/diveMove

.. image:: https://img.shields.io/pypi/v/scikit-diveMove
:target: https://pypi.python.org/pypi/scikit-diveMove
Expand Down Expand Up @@ -147,9 +148,6 @@ installed and available to the user running Python. If needed, install
install.packages("diveMove")
Required Python packages are listed in the `requirements
<requirements.txt>`_ file.

Documentation
=============
Expand All @@ -160,13 +158,11 @@ Alternatively, installing the package as follows:

.. code-block:: sh
pip install -e .["docs"]
pip install -e .["dev"]
allows the documentation to be built locally (choosing the desired target
{"html", "pdf", etc.}):

.. code-block:: sh
make -C docs/ html
The `html` tree is at `docs/build/html`.
2 changes: 1 addition & 1 deletion skdiveMove/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,5 +60,5 @@

__author__ = "Sebastian Luque <[email protected]>"
__license__ = "AGPLv3"
__version__ = "0.3.1.post2"
__version__ = "0.3.1.post3"
__all__ = ["TDR", "calibrate", "dump_config_template"]

0 comments on commit be8c656

Please sign in to comment.