Modernize Sphinx docs build and ReadTheDocs config (#253)

- conf.py: Remove boilerplate (LaTeX, epub, texinfo, man page configs)
- conf.py: Fix language = None to language = 'en' (Sphinx 9 warning)
- conf.py: Update sphinx_click.ext to sphinx_click (modern module name)
- conf.py: Remove unused extensions (doctest, coverage)
- conf.py: Gracefully handle missing wily import (for RTD builds
  where the Rust backend is not compiled)
- requirements_docs.txt: Remove v1 deps (progress, colorlog, tabulate,
  dataclasses, radon, gitpython, plotly, wily itself)
- requirements_docs.txt: Pin sphinx and sphinx-click with version ranges
- readthedocs.yml: Update to v2 config format with Python 3.12
- ci.rst: Fix title underline length warning

Sphinx build now passes with -W (warnings as errors).

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Author: tonybaloney

docs/requirements_docs.txt

@@ -1,12 +1,3 @@
-wily
-sphinx
-sphinx-click
-click
-progress
-colorlog
-plotly
-tabulate
-dataclasses
-radon
-gitpython
-urllib3>=2.6.3 # not directly required, pinned by Snyk to avoid a vulnerability
+sphinx>=7,<9
+sphinx-click>=5,<7
+click>=7,<9

docs/source/ci.rst

@@ -68,7 +68,7 @@ Wily can be called after your tests have completed.
 
 
 GitHub Workflows
-+++++++++
+++++++++++++++++
 
 When using Wily in a Github Workflows, you need to specify to the checkout step to check out the head of the branch and not the merge commit
 

docs/source/conf.py

@@ -1,17 +1,4 @@
-#
-# Configuration file for the Sphinx documentation builder.
-#
-# This file does only contain a selection of the most common options. For a
-# full list see the documentation:
-# http://www.sphinx-doc.org/en/master/config
-
-# -- Path setup --------------------------------------------------------------
-
-# If extensions (or modules to document with autodoc) are in another directory,
-# add these directories to sys.path here. If the directory is relative to the
-# documentation root, use os.path.abspath to make it absolute, like shown here.
-#
-"""Docstring to fix pydocstyle D100 Missing docstring in public module."""
+"""Sphinx configuration for wily documentation."""
 
 import os.path
 import sys
@@ -24,74 +11,35 @@
 copyright = "2018, Anthony Shaw"
 author = "Anthony Shaw"
 
-# The short X.Y version
-import wily
+try:
+    import wily
 
-version = wily.__version__
-# The full version, including alpha/beta/rc tags
-release = "develop"
+    version = wily.__version__
+except ImportError:
+    version = "dev"
 
+release = version
 
 # -- General configuration ---------------------------------------------------
 
-# If your documentation needs a minimal Sphinx version, state it here.
-#
-# needs_sphinx = '1.0'
-
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
 extensions = [
-    "sphinx_click.ext",
+    "sphinx_click",
     "sphinx.ext.autodoc",
-    "sphinx.ext.doctest",
     "sphinx.ext.todo",
-    "sphinx.ext.coverage",
     "sphinx.ext.viewcode",
     "sphinx.ext.githubpages",
 ]
 
-# Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
-
-# The suffix(es) of source filenames.
-# You can specify multiple suffix as a list of string:
-#
-# source_suffix = ['.rst', '.md']
 source_suffix = ".rst"
-
-# The master toctree document.
 master_doc = "index"
-
-# The language for content autogenerated by Sphinx. Refer to documentation
-# for a list of supported languages.
-#
-# This is also used if you do content translation via gettext catalogs.
-# Usually you set "language" from the command line for these cases.
-language = None
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-# This pattern also affects html_static_path and html_extra_path.
+language = "en"
 exclude_patterns = []
 
-# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = None
-
-
 # -- Options for HTML output -------------------------------------------------
 
-# The theme to use for HTML and HTML Help pages.  See the documentation for
-# a list of builtin themes.
-#
 html_theme = "alabaster"
 
-# Theme options are theme-specific and customize the look and feel of a theme
-# further.  For a list of options available for each theme, see the
-# documentation.
-#
-# html_theme_options = {}
-
 html_theme_options = {
     "logo": "logo_below.png",
     "logo_name": False,
@@ -107,102 +55,14 @@
     },
 }
 
-# Add any paths that contain custom static files (such as style sheets) here,
-# relative to this directory. They are copied after the builtin static files,
-# so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ["_static"]
 
-# Custom sidebar templates, must be a dictionary that maps document names
-# to template names.
-#
-# The default sidebars (for documents that don't match any pattern) are
-# defined by theme itself.  Builtin themes are using these templates by
-# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
-# 'searchbox.html']``.
-#
-# html_sidebars = {}
 html_sidebars = {
     "**": ["about.html", "navigation.html", "searchbox.html"],
 }
 
-
-# -- Options for HTMLHelp output ---------------------------------------------
-
-# Output file base name for HTML help builder.
 htmlhelp_basename = "wilydoc"
 
-
-# -- Options for LaTeX output ------------------------------------------------
-
-latex_elements = {
-    # The paper size ('letterpaper' or 'a4paper').
-    #
-    # 'papersize': 'letterpaper',
-    # The font size ('10pt', '11pt' or '12pt').
-    #
-    # 'pointsize': '10pt',
-    # Additional stuff for the LaTeX preamble.
-    #
-    # 'preamble': '',
-    # Latex figure (float) alignment
-    #
-    # 'figure_align': 'htbp',
-}
-
-# Grouping the document tree into LaTeX files. List of tuples
-# (source start file, target name, title,
-#  author, documentclass [howto, manual, or own class]).
-latex_documents = [
-    (master_doc, "wily.tex", "wily Documentation", "Anthony Shaw", "manual")
-]
-
-
-# -- Options for manual page output ------------------------------------------
-
-# One entry per manual page. List of tuples
-# (source start file, name, description, authors, manual section).
-man_pages = [(master_doc, "wily", "wily Documentation", [author], 1)]
-
-
-# -- Options for Texinfo output ----------------------------------------------
-
-# Grouping the document tree into Texinfo files. List of tuples
-# (source start file, target name, title, author,
-#  dir menu entry, description, category)
-texinfo_documents = [
-    (
-        master_doc,
-        "wily",
-        "wily Documentation",
-        author,
-        "wily",
-        "One line description of project.",
-        "Miscellaneous",
-    )
-]
-
-
-# -- Options for Epub output -------------------------------------------------
-
-# Bibliographic Dublin Core info.
-epub_title = project
-
-# The unique identifier of the text. This can be a ISBN number
-# or the project homepage.
-#
-# epub_identifier = ''
-
-# A unique identification for the text.
-#
-# epub_uid = ''
-
-# A list of files that should not be packed into the epub file.
-epub_exclude_files = ["search.html"]
-
-
-# -- Extension configuration -------------------------------------------------
-
 # -- Options for todo extension ----------------------------------------------
 
-# If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = True

readthedocs.yml

@@ -1,7 +1,13 @@
+version: 2
+
 build:
-    image: latest
+  os: ubuntu-24.04
+  tools:
+    python: "3.12"
 
-requirements_file: docs/requirements_docs.txt
+sphinx:
+  configuration: docs/source/conf.py
 
 python:
-    version: 3.6
+  install:
+    - requirements: docs/requirements_docs.txt