From 44e74b18c7872267fb58bef026aba1dbb51cf0c5 Mon Sep 17 00:00:00 2001 From: AlgoFoe Date: Tue, 11 Aug 2026 22:49:45 +0530 Subject: [PATCH 1/2] add brainrender to API doc pipeline --- docs/fetch_repos.py | 1 + docs/source/conf.py | 1 + docs/source/documentation/brainrender/index.md | 8 ++++++++ 3 files changed, 10 insertions(+) diff --git a/docs/fetch_repos.py b/docs/fetch_repos.py index 9203ae4fd..49a4bf713 100644 --- a/docs/fetch_repos.py +++ b/docs/fetch_repos.py @@ -17,6 +17,7 @@ # Use empty string for no optional dependencies. REPOS = [ ("https://github.com/brainglobe/brainglobe-atlasapi.git", "downloads/brainglobe-atlasapi", "main", "[atlasgen]"), + ("https://github.com/brainglobe/brainrender.git", "downloads/brainrender", "main", ""), # Add more (url, path, branch, optional) pairs as needed ] diff --git a/docs/source/conf.py b/docs/source/conf.py index 5a4f21349..0ff5a4fd1 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -44,6 +44,7 @@ "myst_parser", "notfound.extension", "sphinx_copybutton", + "sphinx_autodoc_typehints", "sphinx_gallery.gen_gallery", ] diff --git a/docs/source/documentation/brainrender/index.md b/docs/source/documentation/brainrender/index.md index 12aa62b4c..dc28778e0 100644 --- a/docs/source/documentation/brainrender/index.md +++ b/docs/source/documentation/brainrender/index.md @@ -48,3 +48,11 @@ usage/index If you find brainrender useful and use it in your research, please let us know and also cite the paper: >Claudi, F., Tyson, A. L., Petrucco, L., Margrie, T.W., Portugues, R., Branco, T. (2021) "Visualizing anatomically registered data with Brainrender" eLife 2021;10:e65751 [doi.org/10.7554/eLife.65751](https://doi.org/10.7554/eLife.65751) + + +## API Reference + +```{toctree} +:maxdepth: 1 +api +``` From acd12fcb5170b072a59076490e3c8968fc650bbb Mon Sep 17 00:00:00 2001 From: AlgoFoe Date: Wed, 12 Aug 2026 19:43:41 +0530 Subject: [PATCH 2/2] add sphinx-autodoc-typehints in requirements --- docs/requirements.txt | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/requirements.txt b/docs/requirements.txt index 8f61572c6..43547070c 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -2,6 +2,7 @@ sphinx<9 pydata-sphinx-theme myst-parser numpydoc +sphinx-autodoc-typehints nbsphinx linkify-it-py sphinx-design