Skip to content

Latest commit

 

History

History
86 lines (51 loc) · 3.47 KB

README.rst

File metadata and controls

86 lines (51 loc) · 3.47 KB
Raw

Extracellular Electrophysiology Acquisition NeuroKit Course Materials

This repository contains the materials for learning about ephys data acquisition. The EEA Course is fully online and relies on you to go through the materials yourself.

You can follow the self-paced version or apply for the synchronous course if you’d like to participate in the 5-day course taught by our team as part of the No Black Boxes NeuroKit programme.

This course was originally developed as part of the Cajal Advanced Neuroscience Training Programme.

Building the docs remotely

Pushing to the main branch of the repo triggers GitHub Actions. Gh-actions will generate a virtual environment, build the HTML pages, and then commit and push these to the 'gh-pages' branch, by following the instructions under .github/workflows/sphinx-build. Finally, if under repo settings gh pages is enabled and is set to be deployed from the 'gh-pages' branch, the docs site will be generated at https://username.github.io/reponame. To activate gh pages, go to your repo settings, Pages menu, and under "Build and Deployment", choose gh-pages in the dropdown menu. It should say "Your GitHub Pages sites is currently being built from the gh-pages branch".

Building the docs locally

Building HTML files locally allows you to preview changes before updating the live site. We recommend working with 'virtual environments' in which you can install the (versions of the) python packages that the site needs, without messing up your own installs. Here's how:

With pipenv (recommended)

Requirements (system)

  • make

Requirements (Python 3):

  • pipenv (will automatically download all the project requirements from pypi)

Create a virtual environment with pipenv (will use the Pipfile for installing the necessary packages)

pipenv install

You can then spawn a subshell with

pipenv shell

and then you can use make the usual way

make html     # for html
make latex    # for latex
make latexpdf # for latex (will require latexpdf installed)
make          # list all the available output format

all the outputs will be in docs folder (for html: docs/html)

Exit the virtualenv with

exit

Troubleshooting

No gh-pages` branch? If the gh-pages` branch is not automatically created, the build will fail and complain that there is no such branch. In that case, make an empty branch as follows:

git checkout --orphan gh-pages
git reset --hard
git commit --allow-empty -m "Initialising gh-pages branch"
git push origin gh-pages
git checkout main

Error while building? By default github pages will use Jekyll to generate a static site. To override this, check that there is a .nojekyll file in the gh-pages branch (just an empty file called '.nojekyll').

Acknowledgements

This documentation's source template was taken from the Spinal HDL project.

The theme is based on the PyData Sphinx Theme