Skip to content
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
4 changes: 2 additions & 2 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ html:
<div>Powered by <a href="https://jupyterbook.org/">Jupyter Book</a>.</div>

repository:
url: https://github.com/SCENE-Collaboration/Code_and_Documentation_Guidelines #change me
url: https://github.com/AdaptiveMotorControlLab/WorkspaceTemplate #change me
path_to_book: docs
branch: main

launch_buttons:
colab_url: "https://colab.research.google.com/github/SCENE-Collaboration/Code_and_Documentation_Guidelines/examples/yourdemo.ipynb"
colab_url: "https://colab.research.google.com/github.com/AdaptiveMotorControlLab/WorkspaceTemplate/examples/yourdemo.ipynb"
1 change: 1 addition & 0 deletions _toc.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
format: jb-book
root: docs/StyleGuide
logo: docs/logo.png
parts:
- caption: Main Documentation
chapters:
Expand Down
16 changes: 12 additions & 4 deletions docs/HowTo_JupyterBook.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# What is Jupyterbook?

https://jupyterbook.org/en/stable/intro.html
We use JupyterBook for documentation and sharing computational notebooks. [Here](https://www.nature.com/articles/d41586-018-07196-1) is a nice article for motivation.

📑 The documentation: https://jupyterbook.org/en/stable/intro.html


## Quick start
Expand All @@ -9,7 +11,7 @@ https://jupyterbook.org/en/stable/intro.html
jupyter-book create --cookiecutter YourClonedRepo/
```

### Build from the template provided
## OR Build from the template provided in this Repo!

(1) Use and adapt the two template files (_toc.yml, _config.yml) to your main code base, and be sure to keep the `docs` structure, i.e.,
```
Expand All @@ -26,11 +28,17 @@ jupyter-book create --cookiecutter YourClonedRepo/

TL;DR in the main repo run:
```python
jupyter-book build .
jupyter-book build .
```
and then follow terminal prompt (check errors, etc)- viola!


## Deployment:

To then deploy the book live, see: https://jupyterbook.org/en/stable/publish/gh-pages.html#automatically-host-your-book-with-github-actions

In short, you will set up a git action to deploy to a new branch (that you never merge) called `gh-pages`
In short, Go to Settings > Pages and set up anaction to deploy to a new branch (that you never merge) called `gh-pages`:

![Screen Shot 2025-06-17 at 2 20 19 PM](https://github.com/user-attachments/assets/17d13802-6543-4859-ac09-7abbd491277d)


2 changes: 1 addition & 1 deletion docs/StyleGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

Please see our overall guide on code & project formatting [here](https://github.com/AdaptiveMotorControlLab/WorkspaceTemplate/blob/main/README.md).

### Main Principles 🔨 Organize your code & data :
### Main Principles 🔨 Organize your code & data:
- For experimental and ML projects, please use [DataJoint/databases](https://www.datajoint.com/)
- Be sure you work under a lab repo, typically called "https://github.com/AdaptiveMotorControlLab/YourName_workspace".
- For larger projects (DLC, CEBRA, ExperimentalPipelines, you should be sure your "final" work gets into a pipeline; talk to Mackenzie about this)
Expand Down
Binary file added docs/images/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
41 changes: 0 additions & 41 deletions docs/intro

This file was deleted.