correct version in docs, tidy up

Aharoni-Lab · Jun 22, 2024 · 9d94e56 · 9d94e56
1 parent 4c8b4dd
commit 9d94e56
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 25 deletions.
diff --git a/docs/api/models/sdcard.md b/docs/api/models/sdcard.md
@@ -1,4 +1,4 @@
-# sdCard
+# sdcard
 
 ```{eval-rst}
 .. automodule:: miniscope_io.models.sdcard

diff --git a/docs/conf.py b/docs/conf.py
@@ -6,41 +6,43 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
-project = 'miniscope-io'
-copyright = '2023, Jonny'
-author = 'Jonny, Takuya'
-release = '0.1.8'
+from importlib.metadata import version as _version
+
+project = "miniscope-io"
+copyright = "2023, Jonny"
+author = "Jonny, Takuya"
+release = _version("miniscope-io")
+html_title = "miniscope-io"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
 extensions = [
-    'sphinx.ext.graphviz',
+    "sphinx.ext.graphviz",
     "myst_parser",
-    'sphinx.ext.napoleon',
-    'sphinx.ext.autodoc',
-    'sphinxcontrib.autodoc_pydantic',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.todo'
+    "sphinx.ext.napoleon",
+    "sphinx.ext.autodoc",
+    "sphinxcontrib.autodoc_pydantic",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.todo",
 ]
 
-templates_path = ['_templates']
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
-
+templates_path = ["_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = 'furo'
-html_static_path = ['_static']
+html_theme = "furo"
+html_static_path = ["_static"]
 
 intersphinx_mapping = {
-    'python': ('https://docs.python.org/3', None),
-    'matplotlib': ('https://matplotlib.org/stable/', None),
-    'numpy': ('https://numpy.org/doc/stable/', None),
-    'pandas': ('https://pandas.pydata.org/docs/', None),
-    'rich': ('https://rich.readthedocs.io/en/stable/', None)
+    "python": ("https://docs.python.org/3", None),
+    "matplotlib": ("https://matplotlib.org/stable/", None),
+    "numpy": ("https://numpy.org/doc/stable/", None),
+    "pandas": ("https://pandas.pydata.org/docs/", None),
+    "rich": ("https://rich.readthedocs.io/en/stable/", None),
 }
 
 # ----------
@@ -70,7 +72,7 @@
 # autodoc
 # Mock imports for packages we don't have yet - this one is
 # for opal kelley stuff we need to figure out the licensing for
-autodoc_mock_imports = ['routine']
+autodoc_mock_imports = ["routine"]
 
 # todo
-todo_include_todos = True
+todo_include_todos = True
diff --git a/docs/index.md b/docs/index.md
@@ -9,7 +9,7 @@ guide/usage
 ```
 
 ```{toctree}
-:maxdepth: 2
+:maxdepth: 1
 :caption: API:
 
 api/devices
@@ -26,6 +26,7 @@ api/vendor/index
 
 ```{toctree}
 :caption: Meta:
+:maxdepth: 1
 
 meta/changelog
 meta/contributing

diff --git a/pyproject.toml b/pyproject.toml
@@ -80,7 +80,7 @@ updateDevice = "miniscope_io.device_update:updateDevice"
 [tool.ruff]
 target-version = "py311"
 include = ["miniscope_io/**/*.py", "pyproject.toml"]
-exclude = ["tests", "miniscope_io/vendor", "noxfile.py"]
+exclude = ["docs", "tests", "miniscope_io/vendor", "noxfile.py"]
 line-length = 100
 
 [tool.ruff.lint]