Commit Graph

38 Commits

Author SHA1 Message Date
Jonatan Heyman e14f264f40 Add Google Analytics tracking to docs.locust.io
Done using sphinxcontrib.googleanalytics Sphinx extension.
2024-10-21 12:14:04 +02:00
Sam Wright c33231b6cf Ruff --fix 2024-08-06 16:25:00 +02:00
Sam Wright 015d12324f Configure html_baseurl and jinja on RTD 2024-08-06 16:07:47 +02:00
Sam Wright 3717867609 Conform to style 2024-05-26 16:18:42 +03:00
Sam Wright 088105c9ba Rename css options 2024-05-26 16:15:30 +03:00
Sam Wright 20a8265fba Fix ruff error 2024-05-26 15:54:47 +03:00
Sam Wright a7e34f50c6 Restore theme name 2024-05-26 15:53:49 +03:00
Sam Wright dcc4de7f40 Remove unnecessary python
https://sphinx-rtd-theme.readthedocs.io/en/stable/installing.html
2024-05-26 14:52:54 +03:00
Sam Wright 49353242f8 Add to extensions also?
Mentioned in https://sphinx-rtd-theme.readthedocs.io/en/stable/installing.html#how-to-install-and-use-the-theme
2024-05-26 13:29:04 +03:00
tdadela f99e9df700 sort imports 2024-01-17 00:07:29 +01:00
Lars Holmberg 910b4cfadd Clean up docs/conf.py. html_theme now defaults to "alabaster", so we need to set it when building on readthedocs too. 2023-10-05 23:41:09 +02:00
Lars Holmberg 3777e8d0c9 another attempt at fixing readthedocs: always set sphinx_rtd_theme 2023-10-05 23:18:44 +02:00
Lars Holmberg a7563bf87a Documentation: add links to source code. 2022-12-13 12:31:37 +01:00
Lars Holmberg f356d17c5b Remove some python2-isms 2022-10-31 09:52:10 +01:00
Lars Holmberg 49033127e9 Hide suppressed (deprecated) command line arguments in docs. 2022-10-17 08:30:43 +02:00
Lars Holmberg c13c1cddfd Use text=True for subprocess calls (mainly in tests) instead of sprinkling .decode("utf-8") everywhere 2022-04-26 09:24:07 +02:00
Lars Holmberg 313b80f27f Ran "flynt" on the code base, changing all string handling to use f-strings, instead having a mix of f-strings and %-formatted 2022-02-25 15:32:45 +01:00
Lars Holmberg 6ec972f4db Ran pyupgrade on the code base, removing various "Python2-isms". 2022-02-25 15:06:08 +01:00
Lars Holmberg b17da040f3 Various documentation improvements, including a better "hello world" example to get people started. Added Sphinx Substitution Extension in order to be able to add dynamic stuff (version number) into the documentation. 2021-07-27 13:14:55 +02:00
Lars Holmberg 8ee87dd000 Fix various linting issues (mostly trailing whitespaces & whitespace in newlines) 2020-08-27 23:19:13 +02:00
Lars Holmberg 7c0fcc213d Auto format using Black (20.8b1, which includes the magic trailing commas fix). Added black --check to build. 2020-08-27 09:17:42 +02:00
Jonatan Heyman e91810596b Trying to fix documentation search (while not breaking tables) 2020-06-01 09:45:27 +02:00
Lars Holmberg 5e9d1222d0 Ok, the search on readthedocs is working now. What if I re-enable these help output and env vars? 2020-05-30 19:15:53 +02:00
Lars Holmberg c64713b112 Temporarily disable some documentation stuff to debug #1391 2020-05-30 19:10:53 +02:00
Jonatan Heyman e40edfed6e Add config file keys to settings table in the Configuration docs.
Remove advanced configuration examples from Quickstart docs in favor of just linking to the Configuration docs.
2020-05-01 16:27:58 +02:00
Jonatan Heyman 97491e4f3c * Explicitly set environment variable names for command line options.
* Automatically generate documentation for all available environment variables.
* Rename env variables LOCUST_MASTER, LOCUST_MASTER_PORT in order to make it less likely that they collide with env vars automatically added by Kubernetes. Also change the name of LOCUST_WORKER and LOCUST_MASTER_HOST for consistency.
* Rename env variable CSVFILEBASE to LOCUST_CSV.
* Remove --csv-base-name command line option.
2020-04-28 18:41:53 +02:00
Jonatan Heyman ada1ffac6d Make it possible to have multiline table cells in docs by adding som override CSS 2020-04-13 19:20:40 +02:00
Jonatan Heyman 51547a0e58 Automatically run "locust --help" command when building docs, and include it in the Quickstart section 2020-04-07 16:37:34 +02:00
Lars Holmberg a11a2b76d9 Hide typehints from documentation as it makes method signatures waaaay too long and hard to read. 2020-03-26 09:49:27 +01:00
Lars Holmberg 031e3700bd Add find-as-you-type support for readthedocs. 2020-03-14 15:00:26 +01:00
Jon Dufresne de65fd1589 Use https:// URLs where available (#758) 2018-03-25 20:38:24 -04:00
Mark Beacom 532fec806b
Sort all python imports 2017-09-08 03:47:06 -04:00
Jonatan Heyman c7cc6293f0 Fixed broken docs config 2016-10-07 12:43:05 +02:00
Jonatan Heyman 89318b90fe Use readthedocs Sphinx theme when generating docs locally 2014-05-02 01:05:10 +02:00
Jonatan Heyman d0782d1eb5 Use python-requests lib (partly discussed in #39) 2012-10-25 03:04:55 +02:00
Jonatan Heyman 51c82212b1 Removed Sphinx HTML theme from sphinx conf.py to use the default readthedocs.com instead. 2011-09-05 11:04:38 +02:00
Jonatan Heyman 532d9175f4 Upped version number to 0.2. Added character encoding comment to setup.py. 2011-02-25 15:03:51 +01:00
Jonatan Heyman 45b148b14a Added sphinx documentation for Locust 2011-02-08 23:59:02 +01:00