Remove makefiles, add intersphinx

metatensor · Dec 2, 2023 · 5a612ac · 5a612ac
1 parent 6bd1da8
commit 5a612ac
Show file tree

Hide file tree

Showing 4 changed files with 23 additions and 59 deletions.
diff --git a/docs/Makefile b/docs/Makefile
diff --git a/docs/make.bat b/docs/make.bat
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,4 +1,4 @@
-sphinx                # documentation generator
+sphinx >= 4.0.0       # documentation generator
 sphinx-toggleprompt   # hide the prompt (>>>) in python doctests
 pygments >=2.11       # syntax highligthing
 sphinx_rtd_dark_mode  # sphinx theme
diff --git a/docs/src/conf.py b/docs/src/conf.py
@@ -11,17 +11,36 @@
 author = 'metatensor-models developers'
 release = '2023.11.29'
 
+
 # -- General configuration ---------------------------------------------------
-# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
+needs_sphinx = "4.0.0"
+
+python_use_unqualified_type_names = True
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
 extensions = [
     'sphinx_rtd_dark_mode',
+    "sphinx.ext.viewcode",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.intersphinx",
+    "sphinx_toggleprompt",
+    "myst_parser",
 ]
+
 default_dark_mode = True
 
-templates_path = ['_templates']
-exclude_patterns = []
+autoclass_content = "both"
+autodoc_member_order = "bysource"
+autodoc_typehints = "both"
+autodoc_typehints_format = "short"
 
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3", None),
+    "torch": ("https://pytorch.org/docs/stable/", None),
+}
 
 
 # -- Options for HTML output -------------------------------------------------