Skip to content

Add brainrender API doc support #541

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
AlgoFoe wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Add brainrender API doc support #541

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
44e74b1
add brainrender to API doc pipeline
AlgoFoe Aug 11, 2026
06d81db
Merge branch 'main' of https://github.com/AlgoFoe/brainglobe.github.i…
AlgoFoe Aug 11, 2026
acd12fc
add sphinx-autodoc-typehints in requirements
AlgoFoe Aug 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/fetch_repos.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
]

Expand Down
1 change: 1 addition & 0 deletions docs/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ sphinx<9
pydata-sphinx-theme
myst-parser
numpydoc
sphinx-autodoc-typehints
nbsphinx
linkify-it-py
sphinx-design
Expand Down
1 change: 1 addition & 0 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@
"myst_parser",
"notfound.extension",
"sphinx_copybutton",
"sphinx_autodoc_typehints",
"sphinx_gallery.gen_gallery",
]

Expand Down
8 changes: 8 additions & 0 deletions docs/source/documentation/brainrender/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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&quot; <i>eLife</i> 2021;10:e65751 [doi.org/10.7554/eLife.65751](https://doi.org/10.7554/eLife.65751)


## API Reference

```{toctree}
:maxdepth: 1
api
```
Loading