From 95ccf64575b0d9d47e7ca69d742ac1c8206ef039 Mon Sep 17 00:00:00 2001 From: Nicco Kunzmann Date: Fri, 7 Jun 2024 16:35:26 +0100 Subject: [PATCH] Document how to access the documentation in the browser --- docs/install.rst | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) diff --git a/docs/install.rst b/docs/install.rst index e17be5ab..3807afd0 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -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/