Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Mention installing Locust in Building the Docs #2733

Merged
merged 4 commits into from
Jun 6, 2024
Merged
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 19 additions & 10 deletions docs/developing-locust.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.. _developing-locust:

=================
Developing Locust
=================
=================================
Developing and Documenting Locust
=================================

You want to contribute to Locust? Great! Here is a list of `open bugs/feature requests <https://github.com/locustio/locust/issues>`_.

Expand Down Expand Up @@ -72,19 +72,28 @@ You can validate the whole project using tox:
Build documentation
===================

The documentation source is in the `docs/ <https://github.com/locustio/locust/tree/master/docs/>`_ directory. To build the documentation you first need to install the required Python packages:
The documentation source is in the `docs/ <https://github.com/locustio/locust/tree/master/docs/>`_ directory. To build the documentation

.. code-block:: console
#. Fork Locust on `GitHub <https://github.com/locustio/locust/>`_ and install Lucust in editable mode:
plaindocs marked this conversation as resolved.
Show resolved Hide resolved

$ pip3 install -r docs/requirements.txt
.. code-block:: console

Then you can build the documentation locally using:
$ git clone git://github.com/<YourName>/locust.git # clone the repo
$ pip3 install -e locust/ # install in editable mode

.. code-block:: console
#. Install the documentation requirements:

.. code-block:: console

$ pip3 install -r docs/requirements.txt

#. Build the documentation locally:

.. code-block:: console

$ make build_docs
$ make build_docs

Then the documentation should be build and available at ``docs/_build/index.html``.
View your generated documentation by opening ``docs/_build/index.html``.


Making changes to Locust's Web UI
Expand Down
Loading