Merge pull request #77 from dgarcia360/docs-update-theme-1.4

docs: update theme 1.5

README-dev.md

@@ -1,16 +1,25 @@
-# Building the Docs
-
-The docs build instructions have been tested with Sphinx 4 and Fedora 32.
+# Building the docs
 
 ## Prerequisites
 
-To build and preview the docs locally, you will need to install the following software:
+To build the documentation of this project, you need a UNIX-based operating system. Windows is not fully supported as it does not support symlinks.
+
+You also need the following software installed `doxygen` to generate the reference documentation of the driver. You can install it using the following command:
+
+**Ubuntu**
+
+```bash
+sudo apt-get install doxygen
+```
+
+**MacOS**
+
+```bash
+brew install doxygen
+```
 
-- Git
-- Python 3.7
-- pip
-- doxygen
+Once you have installed the above software, you can build and preview the documentation by following the steps outlined in the [Quickstart guide](https://sphinx-theme.scylladb.com/stable/getting-started/quickstart.html).
 
-## Commands
+## Custom commands
 
-For more information, see [Commands](https://sphinx-theme.scylladb.com/stable/commands.html).
+To generate the reference documentation of the driver, run the command `make javadoc`. This command generates the reference documentation using the Javadoc tool in the `_build/dirhtml/<VERSION>/api` directory.

docs/Makefile

@@ -46,6 +46,7 @@ clean:
 	rm -rf $(BUILDDIR)/*
 	rm -rf $(SOURCEDIR)/*
 	rm -rf $(DOXYGENDIR)/*
+	rm -f poetry.lock
 
 # Generate output commands
 .PHONY: dirhtml

docs/pyproject.toml

@@ -8,11 +8,11 @@ authors = ["ScyllaDB Documentation Contributors"]
 breathe="4.33.1"
 python = "^3.7"
 pyyaml = "6.0"
-pygments = "2.2.0"
+pygments = "2.15.1"
 recommonmark = "0.7.1"
 redirects_cli ="~0.1.2"
-sphinx-scylladb-theme = "~1.3.1"
-sphinx-sitemap = "2.1.0"
+sphinx-scylladb-theme = "~1.5.1"
+sphinx-sitemap = "2.5.0"
 sphinx-autobuild = "2021.3.14"
 Sphinx = "4.3.2"
 sphinx-multiversion-scylla = "~0.2.11"

docs/source/conf.py

@@ -136,7 +136,7 @@ def generate_doxygen(app):
 
 # -- Options for sitemap extension ---------------------------------------
 
-sitemap_url_scheme = 'stable/{link}'
+sitemap_url_scheme = '/stable/{link}'
 
 # -- Options for HTML output ----------------------------------------------
 
@@ -155,8 +155,10 @@ def generate_doxygen(app):
     'github_repository': 'scylladb/cpp-driver',
     'github_issues_repository': 'scylladb/cpp-driver',
     'hide_edit_this_page_button': 'false',
+    'hide_feedback_buttons': 'false',
     'versions_unstable': UNSTABLE_VERSIONS,
     'versions_deprecated': DEPRECATED_VERSIONS,
+    'skip_warnings': 'document_has_underscores'
 }
 
 # If not None, a 'Last updated on:' timestamp is inserted at every page