docs: update theme

docs: update conf.py

docs: update conf.py

docs: Update conf.py

docs: update conf.py

docs: Update conf.py

docs: update conf.py

README-dev.md

@@ -1,17 +1,16 @@
 # Building the docs
 
-The docs build instructions have been tested with Sphinx 4 and Fedora 32.
-
 ## 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 to generate the reference documentation of the driver:
 
-- Git
-- Python 3.7
-- pip
-- Java JDK 8 or above
+- Java JDK 8 or higher
 - Maven
 
-## Commands
+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>`_.
+
+## 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

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

docs/pyproject.toml

@@ -10,7 +10,7 @@ pyyaml = "6.0"
 pygments = "2.2.0"
 recommonmark = "0.7.1"
 redirects_cli ="~0.1.3"
-sphinx-scylladb-theme = "~1.3.1"
+sphinx-scylladb-theme = "~1.4.1"
 sphinx-sitemap = "2.1.0"
 sphinx-autobuild = "2021.3.14"
 Sphinx = "4.3.2"

docs/source/conf.py

@@ -3,6 +3,7 @@
 import os
 from datetime import date
 import re
+import warnings
 from docutils import nodes
 from recommonmark.transform import AutoStructify
 from recommonmark.parser import CommonMarkParser, splitext, urlparse
@@ -169,6 +170,13 @@ def replace_relative_links(app, docname, source):
  result = re.sub(key, app.config.replacements[key], result)
  source[0] = result
 
+
+def build_inited(app):
+ warnings.filterwarnings(
+ action="ignore",
+ message=r".*Document name contains underscores:.*",
+ )
+
 def build_finished(app, exception):
  version_name = os.getenv("SPHINX_MULTIVERSION_NAME", "")
  version_name = "/" + version_name if version_name else ""
@@ -177,6 +185,9 @@ def build_finished(app, exception):
  redirects_cli.create(redirect_to=redirect_to,out_file=out_file)
 
 def setup(app):
+ # Filter warnings
+ app.connect('builder-inited', build_inited)
+
  # Setup Markdown parser
  app.add_source_parser(CustomCommonMarkParser)
  app.add_config_value('recommonmark_config', {
@@ -195,4 +206,5 @@ def setup(app):
  app.connect('source-read', replace_relative_links)
 
  # Create redirect to JavaDoc API
- app.connect('build-finished', build_finished)
+ app.connect('build-finished', build_finished)
+