Update config

Closes #4

.github/dependabot.yml

@@ -1,30 +1,6 @@
-###
-# ```{rubric} Dependabot Config
-# ```
-# ---
-# To get started with Dependabot version updates, you'll need to specify which
-# package ecosystems to update and where the package manifests are located.
-#
-# ```{note}
-# Please see the documentation for all configuration
-# [options](https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file).
-# ```
-#
-# ```{literalinclude} /.github/dependabot.yml
-# :language: yaml
-# :start-at: "version: 2\n"
-# ```
-version: 2
 updates:
-  ###
-  # See documentation for possible values
-  #
-  # - `"pip"`
-  - package-ecosystem: "pip"
-    ###
-    # Location of package manifests
-    #
-    # - `"/"`
-    directory: "/"
+  - directory: "/"
+    package-ecosystem: "pip"
     schedule:
       interval: "weekly"
+version: 2

Pipfile

@@ -21,17 +21,19 @@ version-query = "*"
 
 [docs]
 myst-parser = {extras = ["linkify"], version = "*"}
+six = "*"
 sphinx = "*"
-sphinx-ansible = "*"
 sphinx-autobuild = "*"
 sphinx-book-theme = "*"
 sphinx-copybutton = "*"
 sphinx-design = "*"
 sphinx-favicon = "*"
+sphinx-last-updated-by-git = "*"
 sphinx-notfound-page = "*"
 sphinx-pyscript = "*"
 sphinx-tippy = "*"
 sphinx-togglebutton = "*"
+sphinxcontrib-ansibleautodoc = "*"
 sphinxcontrib-autoyaml = "*"
 sphinxemoji = "*"
 sphinxext-opengraph = "*"

cicd.md

@@ -1,5 +1,4 @@
 ---
-
 abstract: Basic information about the CI/CD processes in this repo.
 authors:
   - name: Xander Harris
@@ -12,8 +11,24 @@ title: GitHub Actions configuration
 
 Stay away from zero days with Dependabot.
 
-```{autoyaml} /.github/dependabot.yml
+<!--
+```{autoyaml} .github/dependabot.yml
+```
+-->
+
+````{sidebar} Dependabot Config
+To get started with Dependabot version updates, you'll need to specify which
+package ecosystems to update and where the package manifests are located.
+
+```{note}
+Please see the documentation for all configuration
+[options](https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file).
+```
+
+```{literalinclude} /.github/dependabot.yml
+:language: yaml
 ```
+````
 
 ## Workflows
 
@@ -40,4 +55,3 @@ And ShellCheck never hurt anybody either.
 
 ```{autoyaml} .github/workflows/shell.yml
 ```
--->

conf.py

@@ -1,81 +1,62 @@
-"""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
+# pylint: disable=invalid-name,redefined-builtin
+"""
+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
+
+-- Project information -----------------------------------------------------
+https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-# -- Project information -----------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+-- General configuration ---------------------------------------------------
+https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 """
-# pylint: disable=invalid-name,redefined-builtin
-from . import get_version
+import sys
+from pathlib import Path
+import version_query
 
-author = 'Xander Harris'
-ansible_roles_path = ['.']
-ansible_tmp_dir = "/tmp/sphinx-ansible"
-autoyaml_root = "."
-autoyaml_depth = 10
 
-copyright = '2024, Xander Harris'
+def get_version():
+    """Get the next expected semantic version for this project."""
+    version = version_query.predict_git_repo(Path('.'))
+    return version.to_str()
 
-# -- General configuration ---------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+sys.path.append(str(Path("ansible/files").resolve()))
+sys.path.append(str(Path("ansible/files/githooks").resolve()))
 
+author = "Xander Harris"
+autoyaml_root = "."
+copyright = "2024, Xander Harris"
 exclude_patterns = [
-    '_build',
-    'Thumbs.db',
-    '.DS_Store',
-    '.venv/*',
-    '.tmp/*',
-    '.pytest_cache/*',
-    '.venv/',
+    "_build",
+    "Thumbs.db",
+    ".DS_Store",
+    ".pytest_cache/*",
+    ".tox/*",
+    ".venv/*",
 ]
-
 extensions = [
-    'myst_parser',
-    'notfound.extension',
-    'sphinx_design',
-    'sphinx_favicon',
-    'sphinx.ext.autodoc',
-    'sphinx.ext.autosectionlabel',
-    'sphinx.ext.autosummary',
-    'sphinx.ext.duration',
-    'sphinx.ext.extlinks',
-    'sphinx.ext.githubpages',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.inheritance_diagram',
-    'sphinxcontrib.autoyaml',
-    'sphinxcontrib.sphinx_ansible',
-]
-
-favicons = [
-    {
-        "sizes": "16x16",
-        "href": "img/ansible-16x16.png",
-    },
-    {
-        "sizes": "32x32",
-        "href": "img/ansible-32x32.png",
-    },
-    {
-        "rel": "apple-touch-icon",
-        "sizes": "180x180",
-        "href": "img/ansible-180x180.png",  # use a local file in _static
-    },
+    "myst_parser",
+    "sphinx_copybutton",
+    "sphinx_design",
+    "sphinx_last_updated_by_git",
+    "sphinx_git",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.coverage",
+    "sphinx.ext.duration",
+    "sphinx.ext.githubpages",
+    "sphinx.ext.graphviz",
+    "sphinx.ext.todo",
+    'sphinxcontrib.ansibleautodoc',
+    "sphinxcontrib.autoyaml",
 ]
-
+git_untracked_check_dependencies = False
+graphviz_output_format = "png"
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
-
-html_static_path = ['_static']
-html_theme = 'sphinx_book_theme'
-html_theme_options = {
-    'logo': '_static/img/ansible.png',
-    "repository_url": "https://github.com/edwardtheharris/ansible-kcp",
-    "use_edit_page_button": True,
-    "use_repository_button": True,
-    "use_source_button": True,
-}
-myst_dmath_double_inline = True
+html_context = {"full_path": str(Path(".").resolve())}
+html_static_path = ["_static"]
+html_theme = "sphinx_book_theme"
 myst_enable_extensions = [
     "amsmath",
     "attrs_block",
@@ -93,11 +74,14 @@
     "substitution",
     "tasklist",
 ]
+myst_footnote_transition = True
 myst_title_to_header = True
-project = 'Ansible Kubernetes Control Plane'
+project = "Ansible Kubernetes Control Plane"
 release = get_version()
 show_authors = True
 source_suffix = {
-    '.md': 'markdown'
+    '.md': 'markdown',
+    '.rst': 'restructuredText',
+    '.txt': 'markdown'
 }
-templates_path = ['_templates']
+templates_path = ["_templates"]