docs: use myst parser

jolars · Dec 13, 2023 · 0288739 · 0288739
1 parent adfa475
commit 0288739
Show file tree

Hide file tree

Showing 10 changed files with 52 additions and 52 deletions.
diff --git a/Makefile b/Makefile
@@ -32,7 +32,7 @@ docs:
 
 .PHONY: autodoc
 autodoc:
-	sphinx-autobuild docs/source docs/build
+	sphinx-autobuild docs/source docs/build --watch sortedl1
 
 .PHONY: update-libslope
 update-libslope:

diff --git a/docs/source/api.md b/docs/source/api.md
@@ -0,0 +1,16 @@
+# API Documentation
+
+```{eval-rst}
+.. currentmodule:: sortedl1
+```
+
+## Estimators
+
+```{eval-rst}
+.. currentmodule:: sortedl1
+
+.. autosummary::
+   :toctree: generated/
+
+    Slope
+```
diff --git a/docs/source/api.rst b/docs/source/api.rst
@@ -14,5 +14,4 @@ Estimators
 .. autosummary::
    :toctree: generated/
 
-   Slope
-
+    Slope
diff --git a/docs/source/changelog.md b/docs/source/changelog.md
@@ -0,0 +1,3 @@
+```{include} ../../CHANGELOG.md
+
+```
diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -18,8 +18,8 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
 extensions = [
-    "sphinx.ext.autodoc",
     "sphinx.ext.autosummary",
+    "sphinx.ext.autodoc",
     "sphinx.ext.doctest",
     "sphinx.ext.intersphinx",
     "sphinx.ext.napoleon",
@@ -43,26 +43,13 @@
 html_static_path = ["_static"]
 html_logo = "_static/slope-horizontal.svg"
 
-# -- Options for napoleon extension ------------------------------------------
-napoleon_google_docstring = True
-napoleon_numpy_docstring = True
-napoleon_include_init_with_doc = False
-napoleon_include_private_with_doc = False
-napoleon_include_special_with_doc = True
-napoleon_use_admonition_for_examples = False
-napoleon_use_admonition_for_notes = False
-napoleon_use_admonition_for_references = False
-napoleon_use_ivar = False
-napoleon_use_param = True
-napoleon_use_rtype = True
-napoleon_preprocess_types = False
-napoleon_type_aliases = None
-napoleon_attr_annotations = True
-
 # - Intersphinx
 intersphinx_mapping = {
     # 'numpy': ('https://docs.scipy.org/doc/numpy/', None),
     # 'scipy': ('https://docs.scipy.org/doc/scipy/reference', None),
     # 'matplotlib': ('https://matplotlib.org/', None),
     "sklearn": ("http://scikit-learn.org/stable", None),
 }
+
+# Myst
+myst_enable_extensions = ["colon_fence", "deflist", "fieldlist"]
diff --git a/docs/source/index.md b/docs/source/index.md
@@ -0,0 +1,12 @@
+# sortedl1
+
+Some **bla**!
+
+```{toctree}
+:maxdepth: 2
+:hidden:
+:caption: Contents
+
+api
+changelog
+```
diff --git a/docs/source/index.rst b/docs/source/index.rst
diff --git a/docs/source/modules.rst b/docs/source/modules.rst
@@ -0,0 +1,7 @@
+sortedl1
+========
+
+.. toctree::
+   :maxdepth: 4
+
+   sortedl1
diff --git a/docs/source/sortedl1.rst b/docs/source/sortedl1.rst
@@ -1,23 +1,19 @@
-##################
- sortedl1 package
-##################
+sortedl1 package
+================
 
-************
- Submodules
-************
+Submodules
+----------
 
-****************************
- sortedl1.estimators module
-****************************
+sortedl1.estimators module
+--------------------------
 
 .. automodule:: sortedl1.estimators
    :members:
    :undoc-members:
    :show-inheritance:
 
-*****************
- Module contents
-*****************
+Module contents
+---------------
 
 .. automodule:: sortedl1
    :members:
-Original file line number
+Diff line change
@@ Expand Up / @@ -14,5 +14,4 @@ Estimators @@
     .. autosummary::
        :toctree: generated/
-       Slope
+        Slope