Skip to content
11 changes: 8 additions & 3 deletions docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -155,14 +155,19 @@ To run the checks manually, run:
Writing Docs
____________

You can run the docs locally by running the following:
`Hatch <https://hatch.pypa.io/latest/>`_ is a unified command-line tool for managing dependencies and environment isolation for Python developers. In Cosmos, we use a Hatchto declare the dependencies required for the project itself, as well as for tests and documentation builds.

If you don’t already have Hatch installed, please `install it <https://hatch.pypa.io/latest/install/>`_ before proceeding. As an example, on macOS, you can do so with:

.. code-block:: bash
brew install hatch

hatch run docs:serve

You can run the docs locally by running the following:

.. code-block:: bash
hatch run docs:serve
Comment thread
lzdanski marked this conversation as resolved.

This will run the docs server in a virtual environment with the right dependencies. Note that it may take longer on the first run as it sets up the virtual environment, but will be quick on subsequent runs.


Building
Expand Down
Loading