Skip to content
Open
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
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,8 +45,7 @@ Here is a list of all files and descriptions included in this repository:
- `docs/Python.ipynb`: Example Jupyter Notebook file containing code for loading data from a `.csv` file and running an analysis in Python. See built webpage [here](https://shawnrhoads.github.io/executable-book-template/Python.html).

### Hosting your Jupyter Book

Once you have added, modified, or deleted any necessary files for your project, then you can publish it via GitHub Pages! To do this, go to your repository Settings > Pages, then make sure your "GitHub Pages site is currently being built from the `gh-pages` branch" and save.
To deploy your executable book, first, navigate to Settings > Actions > General, and under "Workflow permissions", select "Read and write permissions" then click save. This will allow you to modify YAML files for customization. Once you have added, modified, or deleted any necessary files for your project, then you can publish it via GitHub Pages! To do this, go to your repository Settings > Pages, then make sure your "GitHub Pages site is currently being built from the `gh-pages` branch" with `/(roots)` and save.

## Other tips and tricks

Expand All @@ -63,4 +62,4 @@ Please help improve this template! All contributions are welcome and will be cre
- If you have an idea for a template page, please either open a [new issue](https://github.com/shawnrhoads/executable-book-template/issues/new) or submit a pull request with your contribution directly to the repository on GitHub.

As part of the open science community, all contributors must promote and advocate inclusivity through a welcoming environment, giving voice to underrepresented and marginalized people, and creating means and tools in building up a healthy community. Any contributors should please adhere to the following (adapted from the [Contributor Covenant, version 2.0](https://www.contributor-covenant.org/version/2/0/code_of_conduct.html) and [Mozilla's code of conduct](https://github.com/mozilla/diversity)):
<blockquote>I pledge to make participation a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation. I also pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community."</blockquote>
<blockquote>I pledge to make participation a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation. I also pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community."</blockquote>
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This Jupyter Book contains supplemental code and visualizations for the following project:

<blockquote>Rhoads, S. A. (2021). An executable notebook template to enhance interactivity with research objects: An Example Citation. The Journal of Examples.</blockquote>
<blockquote>Rhoads, S. A. (2021). Executable book template. Zenodo. https://doi.org/10.5281/zenodo.5519745</blockquote>
<br>

Please visit the [Getting Started](https://shawnrhoads.github.io/executable-book-template/getting-started.html) page to **use this template for your own projects**!
Please visit the [Getting Started](https://shawnrhoads.github.io/executable-book-template/getting-started.html) page to **use this template for your own projects**!
4 changes: 3 additions & 1 deletion exec-book-template.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ dependencies:
- scipy
- numpy
- matplotlib
- jinja2=3.0.1
- seaborn
- nibabel=3.2.1
- nilearn=0.7.1
Expand All @@ -21,4 +22,5 @@ dependencies:
- jupyter-book==0.10.2
- insipid-sphinx-theme; platform_system != "Windows"
- sphinx-bootstrap-theme; platform_system != "Windows"
- sphinx-inline-tabs; platform_system != "Windows"
- sphinx-inline-tabs; platform_system != "Windows"
- sphinx-book-theme; platform_system != "Windows"