Skip to content

Commit

Permalink
Update pymeos doc version and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Diviloper committed Mar 22, 2024
1 parent 141b315 commit 9655255
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 12 deletions.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,4 +48,8 @@ print(f'Speeds: {speed}')

# Call finish at the end of your code
pymeos_finalize()
````
````

# Documentation

Visit our [ReadTheDocs page](https://pymeos.readthedocs.io/en/latest/) for a more complete and detailed documentation, including an installation manual and several examples.
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
project = 'PyMEOS'
copyright = '2023, Víctor Diví'
author = 'Víctor Diví'
release = '1.1.3.rc2'
release = '1.1.3'

# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
Expand Down
10 changes: 0 additions & 10 deletions docs/src/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,6 @@ time of the PyMEOS release. Install the binary wheel with pip as follows:
$ pip install pymeos
.. warning::
Versions up to 1.1.2 of PyMEOS (0.0.8 of PyMEOS CFFI) should not be used. Instead,
use version 1.1.3 (1.1.0 for PyMEOS CFFI) which is currently in pre-release mode.

To use it, you have to use the ``--pre`` flag of ``pip``. To avoid installing
pre-release versions of the dependencies, install ``pymeos`` normally and then
update it using the following command:

``pip install --pre --force-reinstall --no-deps pymeos pymeos_cffi``

Installation using conda (incoming, not available yet)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down

0 comments on commit 9655255

Please sign in to comment.