Rename swticher generator and add some documentation.

.github/workflows/sphinx.yml

@@ -40,7 +40,7 @@ jobs:
         conda activate corese-core-documentation
         sphinx-multiversion docs/source build/html -D 'exhale_args.containmentFolder=${sourcedir}/java_api'
         chmod u+x docs/swticher_generator.sh
-        ./docs/swticher_generator.sh build/html/switcher.json build/html/index.html
+        ./docs/switcher_generator.sh build/html/switcher.json build/html/index.html
 
     - name: Deploy to GitHub Pages
       uses: peaceiris/actions-gh-pages@v3

docs/README.md

@@ -0,0 +1,25 @@
+# corese-core documentation
+
+The documentation is based on a combination of Sphinx parsing Exhale rst output genrated from Doxygen xml output.
+
+It requires installing some dependencies, installation that can be leverage using pip.
+
+To install the dependencies to build the documentation:
+
+``` shell
+pip install -r docs/requirements.txt
+```
+
+Following that, the corese-core documentation can be generated through a single call to sphinx-multiversion from the root directory of corese-core:
+
+``` shell
+sphinx-multiversion docs/source build/html -D 'exhale_args.containmentFolder=${sourcedir}/java_api' -v
+```
+
+To navigate between versions by means of the switcher (the dropdown list idicating the available version), the switcher.json object must be generated. To improve navigability, a landing page must also be generated to redirect to the latest version of the documentation. To this end a script must be executed and write the output to the output html directory:
+
+```shell
+./docs/switcher_generator.sh build/html/switcher.json build/html/index.html
+```
+
+Both sphinx-multiversion and switcher_generator work on tags following the ``^v[0-9]+\.[0-9]+\.[0-9]+$` syntax, they are ordered by ref name.