Remove doxygen and add sphinx

GetDKAN · Oct 27, 2023 · 05658e0 · 05658e0
1 parent 65c9383
commit 05658e0
Show file tree

Hide file tree

Showing 91 changed files with 7,962 additions and 185 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,5 @@
 .idea
+.vscode
 
 tests/bats
 tests/test_helper
diff --git a/.readthedocs.yaml b/.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
diff --git a/commands/doxygen/dkan-docs b/commands/doxygen/dkan-docs
diff --git a/docker-compose.doxygen.yaml b/docker-compose.doxygen.yaml
diff --git a/docs/Makefile b/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)
diff --git a/docs/_config.yml b/docs/_config.yml
diff --git a/docs/_static/custom.css b/docs/_static/custom.css
@@ -0,0 +1,3 @@
+.wy-side-nav-search > div.version {
+  color: white;
+}
diff --git a/docs/_static/dkan.png b/docs/_static/dkan.png
diff --git a/docs/_static/favicon.ico b/docs/_static/favicon.ico
diff --git a/docs/build/doctrees/demo.doctree b/docs/build/doctrees/demo.doctree
diff --git a/docs/build/doctrees/dktl-convert.doctree b/docs/build/doctrees/dktl-convert.doctree
diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
diff --git a/docs/build/doctrees/frontend.doctree b/docs/build/doctrees/frontend.doctree
diff --git a/docs/build/doctrees/getting-started.doctree b/docs/build/doctrees/getting-started.doctree
diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree
diff --git a/docs/build/doctrees/testing-debug-phpunit.doctree b/docs/build/doctrees/testing-debug-phpunit.doctree
diff --git a/docs/build/doctrees/testing-dkan.doctree b/docs/build/doctrees/testing-dkan.doctree
diff --git a/docs/build/doctrees/testing-project.doctree b/docs/build/doctrees/testing-project.doctree
diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo
@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 7ad9d5f6717aa608cd3611e30a9d1c35
+tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/demo.md → docs/build/html/_sources/demo.rst.txt b/docs/demo.md → docs/build/html/_sources/demo.rst.txt
@@ -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