Merge pull request #625 from niccokunzmann/docs-http-server

Document how to access the documentation in the browser
pull/628/head
Nicco Kunzmann 2024-06-12 12:18:21 +01:00 zatwierdzone przez GitHub
commit 3a54fe77a0
Nie znaleziono w bazie danych klucza dla tego podpisu
ID klucza GPG: B5690EEEBB952194
2 zmienionych plików z 10 dodań i 2 usunięć

Wyświetl plik

@ -9,6 +9,7 @@ Minor changes:
- Add funding information
- Update windows to olson conversion for Greenland Standard Time
- Extend examples in Usage with alarm and recurrence
- Document how to serve the built documentation to view with the browser
Breaking changes:

Wyświetl plik

@ -114,8 +114,8 @@ Try it out:
>>> icalendar.__version__
'5.0.12'
Building the documentation locally
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Building the documentation
--------------------------
To build the documentation follow these steps:
@ -136,3 +136,10 @@ You can also use ``tox`` to build the documentation:
cd icalendar
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/