Update docs

mikelkou · Aug 18, 2023 · 3c0e069 · 3c0e069
1 parent 23cf437
commit 3c0e069
Show file tree

Hide file tree

Showing 6 changed files with 83 additions and 80 deletions.
diff --git a/docs/source/api.md b/docs/source/api.md
@@ -0,0 +1,14 @@
+API
+=====
+
+.. currentmodule:: favapy
+
+.. autosummary::
+    :toctree: generated
+
+    cook
+
+#.. automodule:: favapy
+#   :members:
+#   :undoc-members:
+#   :show-inheritance:
diff --git a/docs/source/api_doc.rst b/docs/source/api_doc.rst
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -3,6 +3,15 @@
 # For the full list of built-in configuration values, see the documentation:
 # https://www.sphinx-doc.org/en/master/usage/configuration.html
 
+# -- Path setup --------------------------------------------------------------
+import sys
+from datetime import datetime
+from importlib.metadata import metadata
+from pathlib import Path
+
+HERE = Path(__file__).parent
+sys.path.insert(0, str(HERE / "extensions"))
+
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
@@ -12,17 +21,60 @@
 version = "0.3.9"
 release = "0.3.9.4"
 
+source_suffix = {
+    ".rst": "restructuredtext",
+    ".ipynb": "myst-nb",
+    ".myst": "myst-nb",
+}
+
+# autodoc
+autosummary_generate = True
+autodoc_member_order = "groupwise"
+default_role = "literal"
+napoleon_google_docstring = False
+napoleon_numpy_docstring = True
+napoleon_include_init_with_doc = False
+napoleon_use_rtype = True  # having a separate entry generally helps readability
+napoleon_use_param = True
+# myst
+myst_heading_anchors = 3  # create anchors for h1-h6
+myst_enable_extensions = [
+    "amsmath",
+    "colon_fence",
+    "dollarmath",
+]
+myst_url_schemes = ("http", "https", "mailto")
+nb_output_stderr = "remove"
+nb_execution_mode = "off"
+nb_merge_streams = True
+pygments_style = "default"
+
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
+# extensions = [
+#    "sphinx.ext.autodoc",
+#    "sphinx.ext.napoleon",
+#    "nbsphinx",
+# ]
+
 extensions = [
-    "sphinx.ext.autodoc",
     "sphinx.ext.napoleon",
-    "nbsphinx",
+    "myst_nb",
+    "sphinx_copybutton",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.viewcode",
+    "sphinxcontrib.bibtex",
+    "sphinx_autodoc_typehints",
+    "sphinx.ext.mathjax",
+    *[p.stem for p in (HERE / "extensions").glob("*.py")],
 ]
 
+
 templates_path = ["_templates"]
-exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "**.ipynb_checkpoints"]
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
@@ -32,7 +84,6 @@
 
 html_logo = "_static/Fava_logo.png"
 html_title = project + " version " + release
-html_theme = "sphinx_rtd_theme"
 html_theme_options = {
     "navigation_with_keys": True,
     "collapse_navigation": False,

diff --git a/docs/source/index.md b/docs/source/index.md
@@ -0,0 +1,14 @@
+:caption: General
+:hidden: true
+:maxdepth: 1
+
+Introduction.rst
+Installation.rst
+Using_FAVA_as_a_Python_library.rst
+Command_Line_Interface.rst
+
+:caption: Tutorials
+:hidden: true
+:maxdepth: 1
+
+tutorials/How_to_use_favapy_in_a_notebook
diff --git a/docs/source/index.rst b/docs/source/index.rst
diff --git a/...rce/How_to_use_favapy_in_a_notebook.ipynb → ...als/How_to_use_favapy_in_a_notebook.ipynb b/...rce/How_to_use_favapy_in_a_notebook.ipynb → ...als/How_to_use_favapy_in_a_notebook.ipynb