API documentation: Change the URL to https://randruc.github.io/Lazuli/doxygen/latest/

* Also add the corresponding information in README and in Sphinx documentation.

Author: randruc

.github/workflows/publish_doxygen_documentation.yml

@@ -34,10 +34,10 @@ jobs:
         run: git fetch && git checkout gh-pages
 
       - name: Prepare the directory
-        run: rm -rf doxygen/head && mkdir -p doxygen/head
+        run: rm -rf doxygen/latest && mkdir -p doxygen/latest
 
       - name: Copy Doxygen artifacts
-        run: cp -r doxygen_output/html/* doxygen/head/
+        run: cp -r doxygen_output/html/* doxygen/latest/
 
       - name: Get rid of doxygen output
         run: rm -rf doxygen_output

README.md

@@ -62,19 +62,21 @@ The Lazuli project has very specific goals that make it unique. These are:
   code or behavior, this is considered as a bug.
 
 
-## Examples
-
-Example programs that use the Lazuli RTOS can be found in the directory
-[example-programs/](example-programs/).
-
-
 ## Documentation
 
 The documentation for the project can be found in the [doc/](doc/) directory.
 
+API documentation can be read at https://randruc.github.io/Lazuli/doxygen/latest/
+
 Two different tools are used to document the project:
 * `sphinx` to generate user documentation from files written in reStructuredText.
-* `doxygen` to generate API documentation from code comments..
+* `doxygen` to generate API documentation from code comments.
+
+
+## Examples
+
+Example programs that use the Lazuli RTOS can be found in the directory
+[example-programs/](example-programs/).
 
 
 ## Prerequisites

doc/index.rst

@@ -36,3 +36,6 @@ of Lazuli.
    developing_your_project
    kernel/kernel_documentation
    glossary
+
+If you wish to read the API documentation, please browse to
+`<https://randruc.github.io/Lazuli/doxygen/latest/>`_

doc/kernel/about_documentation.rst

@@ -84,6 +84,9 @@ Doxygen
 The other kind of documentation comes from code comments with Doxygen commands.
 The official website of Doxygen is `<https://www.doxygen.nl>`_
 
+The API documentation for the project is hosted at
+`<https://randruc.github.io/Lazuli/doxygen/latest/>`_
+
 Code comments
 ^^^^^^^^^^^^^
 

src/doxygen_main_page.dox

@@ -10,7 +10,9 @@
  * This is the Lazuli kernel API and user API documentation. @n
  * @n
  * These pages only document the APIs. For more general documentation about
- * the project and use cases please refer to the corresponding documentation.
+ * the project and use cases please refer to the corresponding documentation. @n
+ *
+ * The project is hosted at https://github.com/randruc/Lazuli @n
  *
  *
  * @section user_api_subsection User API