@@ -215,14 +215,15 @@ Building the documentation locally
215215----------------------------------
216216
217217The project's documentation is built using `Sphinx <https://www.sphinx-doc.org >`_.
218- You can generate it locally to preview your changes before submitting a pull request.
218+ You can generate it locally to preview your changes before submitting a pull
219+ request.
219220
220221
221222Prerequisites
222223--------------
223224
224- Before building the documentation, ensure that all dependencies are installed as described in
225- :ref: `the setup instructions <code >`.
225+ Before building the documentation, ensure that all dependencies are installed
226+ as described in :ref: `the setup instructions <code >`.
226227
227228
228229
@@ -242,22 +243,24 @@ You can then open the documentation in your browser:
242243- **macOS & Linux: ** ``open docs/_build/html/index.html ``
243244- **Windows: ** ``start docs\_build\html\index.html ``
244245
245- *Tox automatically installs the necessary dependencies, so you don’t need to activate a virtual environment manually. *
246+ *Tox automatically installs the necessary dependencies, so you don’t need
247+ to activate a virtual environment manually. *
246248
247249
248250Troubleshooting
249251----------------
250252
251253
252- If you encounter an error about a missing dependency such as ``sphinx-build: command not found ``,
253- ensure that your virtual environment is activated and all dependencies are installed:
254+ If you encounter an error about a missing dependency such as
255+ ``sphinx-build: command not found ``, ensure that your virtual environment is
256+ activated and all dependencies are installed:
254257
255258.. code-block :: bash
256259
257260 pip install -r requirements_dev.txt
258261
259- Alternatively, you can build the documentation using Tox, which automatically handles
260- dependencies and environment setup:
262+ Alternatively, you can build the documentation using Tox, which automatically
263+ handles dependencies and environment setup:
261264
262265.. code-block :: bash
263266
0 commit comments