Document how to access the documentation in the browser

pull/625/head
Nicco Kunzmann 2024-06-07 16:35:26 +01:00
rodzic 9e3b686b72
commit 95ccf64575
1 zmienionych plików z 9 dodań i 2 usunięć

Wyświetl plik

@ -114,8 +114,8 @@ Try it out:
>>> icalendar.__version__ >>> icalendar.__version__
'5.0.12' '5.0.12'
Building the documentation locally Building the documentation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ --------------------------
To build the documentation follow these steps: To build the documentation follow these steps:
@ -136,3 +136,10 @@ You can also use ``tox`` to build the documentation:
cd icalendar cd icalendar
tox -e docs tox -e docs
If you would like to serve the documentation and access it from your browser,
you can run the HTTP server:
.. code-block:: bash
python3 -m http.server -d docs/_build/html/