Skip to content

Update BrainGlobe info #15

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.

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

Merged
merged 5 commits into from
Jan 5, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
15 changes: 0 additions & 15 deletions .github/workflows/PR_docs_check.yml

This file was deleted.

49 changes: 0 additions & 49 deletions .github/workflows/build_and_publish_docs.yml

This file was deleted.

13 changes: 13 additions & 0 deletions .github/workflows/check_docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
name: 'check docs'

on:
pull_request:
branches:
- main

jobs:
check_sphinx_docs:
name: Check Sphinx Docs
runs-on: ubuntu-latest
steps:
- uses: neuroinformatics-unit/actions/check_sphinx_docs@v1
18 changes: 18 additions & 0 deletions .github/workflows/publish_docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: 'publish docs'

# Publish when a git tag is pushed to main
on:
push:
branches:
- main
tags:
- '*'

jobs:
publish_sphinx_docs:
name: Publish Sphinx Docs
runs-on: ubuntu-latest
steps:
- uses: neuroinformatics-unit/actions/publish_sphinx_docs@v1
with:
secret_input: ${{ secrets.GITHUB_TOKEN }}
1 change: 1 addition & 0 deletions docs/requirements.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
sphinx>=5.0,<6.0
pydata-sphinx-theme
myst-parser
sphinx-design
Expand Down
19 changes: 17 additions & 2 deletions docs/source/projects/brainglobe.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,17 @@
# Brainglobe
<TO ADD>
# BrainGlobe

The BrainGlobe Initiative exists to facilitate the development of interoperable Python-based tools for computational neuroanatomy.

We have three aims:

* Develop specialist software for specific analysis and visualisation needs, such as [cellfinder](https://brainglobe.info/cellfinder) and [brainrender](https://docs.brainrender.info/).
* Develop core tools to help others to build interoperable tools in Python, e.g. the [BrainGlobe Atlas API](https://brainglobe.info/atlas-api).
* Build a community of neuroscientists and developers to share knowledge, build software and engage with the scientific, and open-source community (e.g. by organising hackathons).


## Further information:
* [Website](https://brainglobe.info/)
* [Github organisation](https://github.com/brainglobe)
* [Documentation](https://docs.brainglobe.info/)
* [Help forum](https://forum.image.sc/tag/brainglobe)
* [Publications](https://brainglobe.info/publications)