From b0c0eb5490f3e6aeeba8fca792a9e4f3a8221105 2024-03-03 21:32:12
From: Branko Majic <branko@majic.rs>
Date: 2024-03-03 21:32:12
Subject: [PATCH] MAR-192: Upgrade documentation build requirements:

- Current requiremetns no longer seem to work with Python 3.9. Time to
  bump up the Sphinx version.

---

diff --git a/docs/conf.py b/docs/conf.py
index 54e0e7cb7ddce1ac8893c2ed6e3572150cca0f51..4802bcb6edc42f4a40766c7aa481e16a44b7b989 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1,277 +1,28 @@
 # -*- coding: utf-8 -*-
-#
-# Majic Ansible Roles documentation build configuration file, created by
-# sphinx-quickstart on Sat Nov  8 14:03:39 2014.
-#
-# This file is execfile()d with the current directory set to its
-# containing dir.
-#
-# Note that not all possible configuration values are present in this
-# autogenerated file.
-#
-# All configuration values have a default; values that are commented out
-# serve to show the default.
 
-# import sys
-# import os
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
 
-# 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.
-# sys.path.insert(0, os.path.abspath('.'))
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-# -- General configuration ------------------------------------------------
+project = 'Majic Ansible Roles'
+copyright = '2018, 2019, 2020, 2021, 2023, 2024 Branko Majic'
+author = 'Branko Majic'
+release = '7.1-dev'
 
-# If your documentation needs a minimal Sphinx version, state it here.
-# needs_sphinx = '1.0'
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-# Add any Sphinx extension module names here, as strings. They can be
-# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
-# ones.
 extensions = []
 
-# Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
-# The suffix of source filenames.
-source_suffix = '.rst'
-
-# The encoding of source files.
-# source_encoding = 'utf-8-sig'
-
-# The master toctree document.
-master_doc = 'index'
-
-# General information about the project.
-project = u'Majic Ansible Roles'
-copyright = u'2018, Branko Majic'
-
-# The version info for the project you're documenting, acts as replacement for
-# |version| and |release|, also used in various other places throughout the
-# built documents.
-#
-# The short X.Y version.
-version = '7.1-dev'
-# The full version, including alpha/beta/rc tags.
-release = '7.1-dev'
-
-# 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
-
-# There are two options for replacing |today|: either, you set today to some
-# non-false value, then it is used:
-# today = ''
-# Else, today_fmt is used as the format for a strftime call.
-# today_fmt = '%B %d, %Y'
-
-# List of patterns, relative to source directory, that match files and
-# directories to ignore when looking for source files.
-exclude_patterns = ['_build']
-
-# The reST default role (used for this markup: `text`) to use for all
-# documents.
-# default_role = None
-
-# If true, '()' will be appended to :func: etc. cross-reference text.
-# add_function_parentheses = True
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-# If true, the current module name will be prepended to all description
-# unit titles (such as .. function::).
-# add_module_names = True
-
-# If true, sectionauthor and moduleauthor directives will be shown in the
-# output. They are ignored by default.
-# show_authors = False
-
-# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
-
-# A list of ignored prefixes for module index sorting.
-# modindex_common_prefix = []
-
-# If true, keep warnings as "system message" paragraphs in the built documents.
-# keep_warnings = False
-
-
-# -- 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 = 'sphinx_rtd_theme'
-
-# 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 = {}
-
-# Add any paths that contain custom themes here, relative to this directory.
-# html_theme_path = []
-
-# The name for this set of Sphinx documents.  If None, it defaults to
-# "<project> v<release> documentation".
-# html_title = None
-
-# A shorter title for the navigation bar.  Default is the same as html_title.
-# html_short_title = None
-
-# The name of an image file (relative to this directory) to place at the top
-# of the sidebar.
-# html_logo = None
-
-# The name of an image file (within the static path) to use as favicon of the
-# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
-# pixels large.
-# html_favicon = None
-
-# 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']
-
-# Add any extra paths that contain custom files (such as robots.txt or
-# .htaccess) here, relative to this directory. These files are copied
-# directly to the root of the documentation.
-# html_extra_path = []
-
-# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
-# using the given strftime format.
-# html_last_updated_fmt = '%b %d, %Y'
-
-# If true, SmartyPants will be used to convert quotes and dashes to
-# typographically correct entities.
-# html_use_smartypants = True
-
-# Custom sidebar templates, maps document names to template names.
-# html_sidebars = {}
-
-# Additional templates that should be rendered to pages, maps page names to
-# template names.
-# html_additional_pages = {}
-
-# If false, no module index is generated.
-# html_domain_indices = True
-
-# If false, no index is generated.
-# html_use_index = True
-
-# If true, the index is split into individual pages for each letter.
-# html_split_index = False
-
-# If true, links to the reST sources are added to the pages.
-# html_show_sourcelink = True
-
-# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-# html_show_sphinx = True
-
-# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-# html_show_copyright = True
-
-# If true, an OpenSearch description file will be output, and all pages will
-# contain a <link> tag referring to it.  The value of this option must be the
-# base URL from which the finished HTML is served.
-# html_use_opensearch = ''
-
-# This is the file name suffix for HTML files (e.g. ".xhtml").
-# html_file_suffix = None
-
-# Language to be used for generating the HTML full-text search index.
-# Sphinx supports the following languages:
-#   'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
-#   'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
-# html_search_language = 'en'
-
-# A dictionary with options for the search language support, empty by default.
-# Now only 'ja' uses this config value
-# html_search_options = {'type': 'default'}
-
-# The name of a javascript file (relative to the configuration directory) that
-# implements a search results scorer. If empty, the default will be used.
-# html_search_scorer = 'scorer.js'
-
-# Output file base name for HTML help builder.
-htmlhelp_basename = 'MajicAnsibleRolesdoc'
-
-# -- 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 = [
-  ('index', 'MajicAnsibleRoles.tex', u'Majic Ansible Roles Documentation',
-   u'Branko Majic', 'manual'),
-]
-
-# The name of an image file (relative to this directory) to place at the top of
-# the title page.
-# latex_logo = None
-
-# For "manual" documents, if this is true, then toplevel headings are parts,
-# not chapters.
-# latex_use_parts = False
-
-# If true, show page references after internal links.
-# latex_show_pagerefs = False
-
-# If true, show URL addresses after external links.
-# latex_show_urls = False
-
-# Documents to append as an appendix to all manuals.
-# latex_appendices = []
-
-# If false, no module index is generated.
-# latex_domain_indices = True
-
-
-# -- Options for manual page output ---------------------------------------
-
-# One entry per manual page. List of tuples
-# (source start file, name, description, authors, manual section).
-man_pages = [
-    ('index', 'majicansibleroles', u'Majic Ansible Roles Documentation',
-     [u'Branko Majic'], 1)
-]
-
-# If true, show URL addresses after external links.
-# man_show_urls = False
-
-
-# -- 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 = [
-  ('index', 'MajicAnsibleRoles', u'Majic Ansible Roles Documentation',
-   u'Branko Majic', 'MajicAnsibleRoles', 'One line description of project.',
-   'Miscellaneous'),
-]
-
-# Documents to append as an appendix to all manuals.
-# texinfo_appendices = []
-
-# If false, no module index is generated.
-# texinfo_domain_indices = True
-
-# How to display URL addresses: 'footnote', 'no', or 'inline'.
-# texinfo_show_urls = 'footnote'
-
-# If true, do not generate a @detailmenu in the "Top" node's menu.
-# texinfo_no_detailmenu = False
diff --git a/requirements.in b/requirements.in
index b21ee10f6962924027ed7c6f0e7e09ce2137d0a1..190917c3f2cd61b19b54f3458d6a87a03cf88846 100644
--- a/requirements.in
+++ b/requirements.in
@@ -13,5 +13,5 @@ python-vagrant
 rich<11.0.0
 setuptools
 sh~=1.14.0
-sphinx~=1.7.0
-sphinx_rtd_theme~=0.4.0
+sphinx
+sphinx-rtd-theme
diff --git a/requirements.txt b/requirements.txt
index 5adcd6b10a8bcae883ab9e7691fbb4ea7e4a5082..459e657d6eb7373169a1ccd7dd9e0029c67f77dc 100644
--- a/requirements.txt
+++ b/requirements.txt
@@ -25,7 +25,7 @@ bcrypt==4.1.2
     # via paramiko
 binaryornot==0.4.4
     # via cookiecutter
-build==1.0.3
+build==1.1.1
     # via pip-tools
 cerberus==1.3.5
     # via molecule
@@ -57,7 +57,7 @@ colorama==0.4.6
     #   rich
 commonmark==0.9.1
     # via rich
-cookiecutter==2.5.0
+cookiecutter==2.6.0
     # via molecule
 cryptography==3.2.1
     # via
@@ -68,10 +68,12 @@ defusedxml==0.7.1
     # via -r requirements.in
 distlib==0.3.8
     # via virtualenv
-dnspython==2.6.0
+dnspython==2.6.1
     # via -r requirements.in
 docutils==0.20.1
-    # via sphinx
+    # via
+    #   sphinx
+    #   sphinx-rtd-theme
 exceptiongroup==1.2.0
     # via pytest
 fasteners==0.19
@@ -82,14 +84,16 @@ flake8==7.0.0
     # via molecule
 gimmecert==0.5.0
     # via -r requirements.in
-identify==2.5.34
+identify==2.5.35
     # via pre-commit
 idna==3.6
     # via requests
 imagesize==1.4.1
     # via sphinx
 importlib-metadata==7.0.1
-    # via build
+    # via
+    #   build
+    #   sphinx
 iniconfig==2.0.0
     # via pytest
 jinja2==3.1.3
@@ -156,7 +160,7 @@ pyproject-hooks==1.0.0
     # via
     #   build
     #   pip-tools
-pytest==8.0.1
+pytest==8.0.2
     # via testinfra
 python-dateutil==2.8.2
     # via
@@ -208,19 +212,29 @@ six==1.16.0
     #   paramiko
     #   pre-commit
     #   python-dateutil
-    #   sphinx
     #   testinfra
 snowballstemmer==2.2.0
     # via sphinx
-sphinx==1.7.9
+sphinx==7.2.6
     # via
     #   -r requirements.in
     #   sphinx-rtd-theme
-sphinx-rtd-theme==0.4.3
+    #   sphinxcontrib-jquery
+sphinx-rtd-theme==2.0.0
     # via -r requirements.in
+sphinxcontrib-applehelp==1.0.8
+    # via sphinx
+sphinxcontrib-devhelp==1.0.6
+    # via sphinx
+sphinxcontrib-htmlhelp==2.0.5
+    # via sphinx
+sphinxcontrib-jquery==4.1
+    # via sphinx-rtd-theme
+sphinxcontrib-jsmath==1.0.1
+    # via sphinx
+sphinxcontrib-qthelp==1.0.7
+    # via sphinx
 sphinxcontrib-serializinghtml==1.1.10
-    # via sphinxcontrib-websupport
-sphinxcontrib-websupport==1.2.4
     # via sphinx
 tabulate==0.9.0
     # via molecule
@@ -242,7 +256,7 @@ types-python-dateutil==2.8.19.20240106
     # via arrow
 urllib3==2.2.1
     # via requests
-virtualenv==20.25.0
+virtualenv==20.25.1
     # via pre-commit
 wheel==0.42.0
     # via pip-tools
@@ -256,9 +270,8 @@ pip==24.0
     # via
     #   -r requirements.in
     #   pip-tools
-setuptools==69.1.0
+setuptools==69.1.1
     # via
     #   -r requirements.in
     #   nodeenv
     #   pip-tools
-    #   sphinx