Remove doxygen and add sphinx

.gitignore

@@ -1,4 +1,6 @@
 .idea
+.vscode
 
+docs/build
 tests/bats
 tests/test_helper

.readthedocs.yaml

@@ -0,0 +1,29 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.9"
+    # You can also specify other tool versions:
+    # nodejs: "19"
+    # rust: "1.64"
+    # golang: "1.19"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+   configuration: docs/conf.py
+
+# If using Sphinx, optionally build your docs in additional formats such as PDF
+# formats:
+#    - pdf
+
+# Optionally declare the Python requirements required to build your docs
+python:
+   install:
+   - requirements: docs/requirements.txt

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/_static/custom.css

@@ -0,0 +1,3 @@
+.wy-side-nav-search > div.version {
+  color: white;
+}

docs/conf.py

@@ -0,0 +1,72 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# This file only contains a selection of the most common options. For a full
+# list see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- 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.
+#
+import os
+import sys
+#sys.path.insert(0, os.path.abspath('../../modules/'))
+#sys.path.append(os.path.abspath('..'))
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'DKAN DDEV Addon Documentation'
+copyright = '2023, CivicActions'
+author = 'CivicActions'
+
+# The full version, including alpha/beta/rc tags
+version = '1.x'
+
+# -- 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.
+# sphinxcontrib-phpdomain is not compatible with myst.
+extensions = [
+  'myst_parser',
+  'sphinx_rtd_theme',
+  'sphinx_prompt'
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# 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.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+
+# -- 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'
+
+# 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']
+html_css_files = ['custom.css']
+html_logo = ''
+html_favicon = '_static/dkan.png'
+
+# The suffix of source filenames.
+source_suffix = {
+    '.rst': 'restructuredtext',
+    '.md': 'markdown',
+}
+source_parsers = {'.md': 'myst_parser.sphinx_'}
+
+autosectionlabel_prefix_document = True
+autosectionlabel_maxdepth=None

docs/demo.md → docs/demo.rst

@@ -1,16 +1,23 @@
-# Run The DKAN Demo Site
+Run The DKAN Demo Site
+======================
 
 Note: As of DDev 1.19.5, these instructions require managing the settings.php
 file. After DDev 1.19.6 is released, this will (hopefully) not be required.
 
+.. prompt:: bash $
+
     mkdir my-project && cd my-project
     ddev config --auto
     ddev get getdkan/dkan-ddev-addon
     ddev restart
     ddev composer create getdkan/recommended-project:@dev -y
-    # At this point, we must add a configuration to settings.php
-    # This should change after DDev 1.19.6 is released.
+
+At this point, we must add a configuration to settings.php
+
+This should change after DDev 1.19.6 is released.
+
+.. prompt:: bash $
+
     cat .ddev/misc/settings.dkan-snippet.php.txt >> docroot/sites/default/settings.php
     cp .ddev/misc/settings.dkan.php docroot/sites/default/settings.dkan.php
-
     ddev dkan-demo