add theory section to user docs

ia267 · ia267 · commit a189a8e1e1aa · 2025-02-05T19:40:09.000Z
diff --git a/docs/docs-requirements.txt b/docs/docs-requirements.txt
@@ -8,3 +8,4 @@ sphinx-autobuild
 ford
 ghp-import
 sphinx_material
+sphinxcontrib-tikz
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -50,6 +50,7 @@
     'sphinx.ext.napoleon',
     'sphinx.ext.mathjax',
     'sphinx_rtd_theme',
+    'sphinxcontrib.tikz',
     'sphinx.ext.graphviz'
 ]
 
@@ -88,3 +89,9 @@
 html_sidebars = {
     "**": ["logo-text.html", "globaltoc.html", "localtoc.html", "searchbox.html"]
 }
+
+latex_elements = {
+    "preamble": r"""
+    \usepackage{tikz}
+    """
+}
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -21,6 +21,6 @@ Contents:
 
    getting_started.rst
    report_a_bug
-   internals/index
+   user/index
    developer/index
    API reference <https://xcompact3d.github.io/x3d2>
diff --git a/docs/source/user/index.rst b/docs/source/user/index.rst
@@ -0,0 +1,26 @@
+.. x3d2 documentation master file, created by
+   sphinx-quickstart on Mon Feb 27 14:46:56 2023.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+==================
+x3d2 Documentation
+==================
+
+**x3d2** is the current codename for what is to become Xcompact3d
+version 2.0.  This project is a rewrite of Xcompact3d leading to
+
+* Improved serial and parallel performance.
+* Support for NVIDIA GPU accelerators (using CUDA Fortran).
+* Improved modularity and testability.
+
+Contents:
+
+.. toctree::
+   :maxdepth: 2
+
+   getting_started.rst
+   report_a_bug
+   user/index
+   developer/index
+   API reference <https://xcompact3d.github.io/x3d2>
diff --git a/docs/source/user/theory.rst b/docs/source/user/theory.rst
