update documentation

PHAREHUB · May 21, 2024 · 689a145 · 689a145
1 parent 25a9256
commit 689a145
Show file tree

Hide file tree

Showing 23 changed files with 592 additions and 469 deletions.
diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -21,7 +21,7 @@
 # -- Project information -----------------------------------------------------
 
 project = "PHARE"
-copyright = "2018-2023, Nicolas Aunai, Roch Smets, Philip Deegan"
+copyright = "2018-2024, Nicolas Aunai, Roch Smets, Philip Deegan"
 author = "Nicolas Aunai, Roch Smets, Philip Deegan"
 
 # The short X.Y version
@@ -43,22 +43,28 @@
     "sphinx.ext.autodoc",
     "sphinx.ext.mathjax",
     "sphinx.ext.githubpages",
-    "sphinx.ext.autodoc",
     "sphinx.ext.viewcode",
     "sphinx.ext.doctest",
     "sphinx.ext.intersphinx",
     "sphinx.ext.autosectionlabel",
     "sphinx_gallery.load_style",
     "sphinx_codeautolink",
-    "sphinxcontrib.apidoc",
+    #    "sphinxcontrib.apidoc",
     "nbsphinx",
-    "numpydoc",
+    # "numpydoc",
 ]
-apidoc_module_dir = "../../pyphare"
-apidoc_output_dir = "development"
-apidoc_separate_modules = True
-apidoc_module_first = True
+# apidoc_module_dir = "../../pyphare"
+# apidoc_output_dir = "development"
+# apidoc_separate_modules = True
+# apidoc_module_first = True
+
+# autosummary_generate = False
 
+autodoc_default_options = {
+    "members": True,
+    "private-members": False,
+    "special-members": False,
+}
 
 autosectionlabel_prefix_document = True
 codeautolink_custom_blocks = {
@@ -104,7 +110,8 @@
 exclude_patterns = []
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = None
+# pygments_style = None
+pygments_style = "sphinx"
 
 
 # -- Options for HTML output -------------------------------------------------

diff --git a/doc/source/development/tests.rst b/doc/source/development/tests.rst
diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -76,9 +76,9 @@ the mesh resolution wherever the solution needs it.
    :maxdepth: 1
    :hidden:
 
+   usage/simulation_inputs
    usage/run_from_python
    usage/run_from_exe
-   usage/simulation_inputs
    usage/examples
 
 
@@ -98,14 +98,6 @@ the mesh resolution wherever the solution needs it.
 
 
 
-.. Development
-.. -----------
-.. toctree::
-   :caption: DEVELOPMENT
-   :maxdepth: 1
-   :hidden:
-
-   development/tests
 
 .. Indices and tables
 .. ------------------

diff --git a/doc/source/modules.rst b/doc/source/modules.rst
diff --git a/doc/source/pyphare.core.rst b/doc/source/pyphare.core.rst
diff --git a/doc/source/pyphare.cpp.rst b/doc/source/pyphare.cpp.rst
diff --git a/doc/source/pyphare.data.rst b/doc/source/pyphare.data.rst
diff --git a/doc/source/pyphare.pharein.rst b/doc/source/pyphare.pharein.rst
diff --git a/doc/source/pyphare.pharesee.rst b/doc/source/pyphare.pharesee.rst
diff --git a/doc/source/pyphare.rst b/doc/source/pyphare.rst
diff --git a/doc/source/pyphare.simulator.rst b/doc/source/pyphare.simulator.rst
diff --git a/doc/source/pyphare_tests.rst b/doc/source/pyphare_tests.rst
diff --git a/doc/source/pyphare_tests.test_core.rst b/doc/source/pyphare_tests.test_core.rst