Api docs

.gitignore

@@ -24,3 +24,6 @@ venv.bak/
 docs/jupyterlite/.cache/
 docs/jupyterlite/.jupyterlite.doit.db
 docs/jupyterlite/_output/
+
+# autodoc2 generated
+docs/apidocs

docs/_static/favicon/browserconfig.xml

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="utf-8"?>
+<browserconfig>
+    <msapplication>
+        <tile>
+            <square150x150logo src="/mstile-150x150.png"/>
+            <TileColor>#da532c</TileColor>
+        </tile>
+    </msapplication>
+</browserconfig>

docs/_static/favicon/site.webmanifest

@@ -0,0 +1,19 @@
+{
+    "name": "",
+    "short_name": "",
+    "icons": [
+        {
+            "src": "/android-chrome-192x192.png",
+            "sizes": "192x192",
+            "type": "image/png"
+        },
+        {
+            "src": "/android-chrome-512x512.png",
+            "sizes": "512x512",
+            "type": "image/png"
+        }
+    ],
+    "theme_color": "#ffffff",
+    "background_color": "#ffffff",
+    "display": "standalone"
+}

docs/advanced.md

@@ -1,5 +1,4 @@
 # Advanced
-----------
 
 ## Returning Values
 

docs/conf.py

@@ -18,12 +18,14 @@
 import subprocess
 import os
 import re
+from datetime import date
 
 # -- Project information -----------------------------------------------------
 
 project = 'itkwidgets'
-copyright = '2023, NumFOCUS'
 author = 'Matthew McCormick'
+copyright = f'{date.today().year}, NumFOCUS'
+author = 'Insight Software Consortium'
 
 # The full version, including alpha/beta/rc tags.
 release = re.sub('^v', '', os.popen('git tag --list "v1.0*" --sort=creatordate').readlines()[-1].strip())
@@ -36,7 +38,37 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['myst_parser',]
+extensions = [
+    'sphinx.ext.autosummary',
+    'autodoc2',
+    'myst_parser',
+    'sphinx_copybutton',
+    'sphinx.ext.intersphinx',
+    'sphinxext.opengraph',
+    'sphinx_design',
+]
+
+autodoc2_packages = [
+    {
+        "path": "../itkwidgets",
+        "exclude_files": [],
+    },
+]
+autodoc2_render_plugin = "myst"
+
+myst_enable_extensions = [
+    "colon_fence",
+    "dollarmath",  # Support syntax for inline and block math using `$...$` and `$$...$$`
+                   # (see https://myst-parser.readthedocs.io/en/latest/syntax/optional.html#dollar-delimited-math)
+    "fieldlist",
+    "linkify",  # convert bare links to hyperlinks
+]
+
+intersphinx_mapping = {
+    "itkwasm": ("https://wasm.itk.org/en/latest/", None),
+    "python": ("https://docs.python.org/3/", None),
+    "numpy": ("https://numpy.org/doc/stable", None),
+}
 
 html_theme_options = dict(
     github_url='https://github.com/InsightSoftwareConsortium/itkwidgets',
@@ -59,7 +91,19 @@
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-html_theme = 'pydata_sphinx_theme'
+html_theme = 'furo'
+html_logo = "_static/itkwidgets_logo_small.png"
+html_favicon = "_static/favicon/favicon.ico"
+html_title = f"{project}'s documentation"
+
+# Furo options
+html_theme_options = {
+    "top_of_page_button": "edit",
+    "source_repository": "https://github.com/InsightSoftwareConsortium/itkwidgets/",
+    "source_branch": "main",
+    "source_directory": "docs",
+}
+
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,

docs/index.md

@@ -19,9 +19,26 @@ Try it with JupyterLite!
 </a>
 
 ```{toctree}
-quick_start_guide.rst
-deployments.rst
-integrations.rst
-development.rst
-advanced.rst
+:maxdepth: 4
+:caption: 📖 Learn
+
+quick_start_guide
+deployments
+integrations
+advanced
+```
+
+```{toctree}
+:maxdepth: 3
+:caption: 📖 Reference
+
+apidocs/index.rst
+```
+
+```{toctree}
+:maxdepth: 2
+:caption: 🔨 Contribute
+
+development
+Code of Conduct <https://docs.itk.org/en/latest/contributing/code_of_conduct.html>
 ```

docs/quick_start_guide.md

@@ -69,19 +69,19 @@ cd itkwidgets/examples
 
 ### Notebook
 
-In Jupyter, import the view function:
+In Jupyter, import the {py:obj}`view <itkwidgets.viewer.view>` function:
 
 ```python
 from itkwidgets import view
 ```
 
-Then, call the view function at the end of a cell, passing in the image to examine:
+Then, call the {py:obj}`view <itkwidgets.viewer.view>` function at the end of a cell, passing in the image to examine:
 
 ```python
 view(image)
 ```
 
-For information on additional options, see the view function docstring:
+For information on additional options, see the {py:obj}`view <itkwidgets.viewer.view>` function docstring:
 
 ```python
 view?

docs/requirements.txt

@@ -1,4 +1,9 @@
+furo
 imjoy_jupyterlab_extension
-pydata-sphinx-theme
-myst-parser
 jupyterlite[all]==0.1.0b17
+myst-parser[linkify]
+pydata-sphinx-theme
+sphinx-autodoc2>=0.5.0
+sphinx-copybutton
+sphinx-design
+sphinxext-opengraph