Skip to content

Commit

Permalink
Fix index.rst. (#519)
Browse files Browse the repository at this point in the history
There was an issue with the formatting on `index.rst`. Fixed now.
  • Loading branch information
andrewtarzia committed Nov 9, 2023
1 parent 935ecbc commit ee9c3cc
Showing 1 changed file with 13 additions and 11 deletions.
24 changes: 13 additions & 11 deletions docs/source/index.rst
Expand Up @@ -90,25 +90,27 @@ To get :mod:`.stk`, you can install it with pip::

$ pip install stk

Installing a development enviromnent is easy too:

#. Use a new Python 3.11 environment through `conda`_ or `mamba`_.
Developer Setup
...............

#. Install `just`_.
#. Clone the :mod:`.stk` repository.
#. Setup development enviromnent::
#. In a new virtual environment run::

$ just dev

$ just dev
#. Setup the `MongoDB`_ container (make sure ``docker`` is installed)::

#. Setup the `MongoDB`_ container (make sure `docker` is installed)::
$ just mongo

$ just mongo
#. Run code checks::

#. Test installation (running `black`, `mypy`, `pytest` and tests `make` on the docs)::
$ just check

$ just check

.. _`mamba`: https://mamba.readthedocs.io/en/latest/mamba-installation.html#mamba-install
.. _`conda`: https://docs.conda.io/en/latest/
.. _`just`: https://github.com/casey/just
.. _`MongoDB`: https://www.mongodb.com/docs/manual/tutorial/install-mongodb-on-ubuntu/

Expand Down

0 comments on commit ee9c3cc

Please sign in to comment.