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.

Sign up for GitHub

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

Jump to bottom

Improve documentation structure #2278

Merged
merged 2 commits into from Dec 21, 2022
Merged

Improve documentation structure #2278

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
050a5f6
docs: add chapter captions for side menu
THUzxj Dec 21, 2022
d430bd7
docs: fix caption levels in configuration.rst
THUzxj Dec 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
13 changes: 7 additions & 6 deletions docs/configuration.rst
View file
Open in desktop
@@ -1,11 +1,12 @@
.. _configuration:

=============
Configuration
=============


Command Line Options
--------------------
====================

Locust is configured mainly through command line arguments.

Expand All @@ -21,7 +22,7 @@ Locust is configured mainly through command line arguments.
.. _environment-variables:

Environment Variables
---------------------
=====================

Options can also be set through through environment variables. They are typically the same as the command line argument but capitalized and prefixed with ``LOCUST_``:

Expand All @@ -41,7 +42,7 @@ On Windows:
.. _configuration-file:

Configuration File
------------------
==================

Options can also be set in a configuration file in the `config file <https://github.com/bw2/ConfigArgParse#config-file-syntax>`_
format.
Expand Down Expand Up @@ -77,7 +78,7 @@ Example:
~/locust.conf -> ./locust.conf -> (file specified using --conf) -> env vars -> cmd args

All available configuration options
-----------------------------------
===================================

Here's a table of all the available configuration options, and their corresponding Environment and config file keys:

Expand Down Expand Up @@ -164,12 +165,12 @@ The Web UI will display:
|

Custom arguments
----------------
================

See :ref:`custom-arguments`

Customization of statistics settings
------------------------------------
====================================

Default configuration for Locust statistics is set in constants of stats.py file.
It can be tuned to specific requirements by overriding these values.
Expand Down
7 changes: 7 additions & 0 deletions docs/index.rst
View file
Open in desktop
Expand Up @@ -16,6 +16,7 @@ Getting started

.. toctree ::
:maxdepth: 2
:caption: Getting started

what-is-locust
installation
Expand All @@ -27,6 +28,7 @@ Writing Locust tests

.. toctree ::
:maxdepth: 2
:caption: Writing Locust tests

writing-a-locustfile

Expand All @@ -36,6 +38,7 @@ Running your Locust tests

.. toctree ::
:maxdepth: 1
:caption: Running your Locust tests

configuration
running-distributed
Expand All @@ -50,6 +53,7 @@ Other functionalities

.. toctree ::
:maxdepth: 2
:caption: Other functionalities

custom-load-shape
retrieving-stats
Expand All @@ -65,6 +69,7 @@ Further reading / knowledgebase

.. toctree ::
:maxdepth: 1
:caption: Further reading / knowledgebase

developing-locust
further-reading
Expand All @@ -74,6 +79,7 @@ API
---
.. toctree ::
:maxdepth: 4
:caption: API

api

Expand All @@ -84,5 +90,6 @@ Changelog

.. toctree ::
:maxdepth: 2
:caption: Changelog

changelog