From a08afcc7565a2f37c5c7f2f379c3fb898973ed03 Mon Sep 17 00:00:00 2001 From: QiNan <53305147+fuqixiu@users.noreply.github.com> Date: Fri, 12 Jul 2024 11:14:42 -0400 Subject: [PATCH] Jinja version update The following changes are being made: - updated yml for Jinja version specification - added new Sphinx book theme - edited README for Action permission setting instruction - updated home page template with proper citation --- README.md | 5 ++--- docs/index.md | 4 ++-- exec-book-template.yml | 4 +++- 3 files changed, 7 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 5544d39..60101bf 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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)): -
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."
\ No newline at end of file +
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."
diff --git a/docs/index.md b/docs/index.md index cb423ce..5c25913 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,7 +2,7 @@ This Jupyter Book contains supplemental code and visualizations for the following project: -
Rhoads, S. A. (2021). An executable notebook template to enhance interactivity with research objects: An Example Citation. The Journal of Examples.
+
Rhoads, S. A. (2021). Executable book template. Zenodo. https://doi.org/10.5281/zenodo.5519745

-Please visit the [Getting Started](https://shawnrhoads.github.io/executable-book-template/getting-started.html) page to **use this template for your own projects**! \ No newline at end of file +Please visit the [Getting Started](https://shawnrhoads.github.io/executable-book-template/getting-started.html) page to **use this template for your own projects**! diff --git a/exec-book-template.yml b/exec-book-template.yml index 4e59e5e..0193692 100644 --- a/exec-book-template.yml +++ b/exec-book-template.yml @@ -12,6 +12,7 @@ dependencies: - scipy - numpy - matplotlib + - jinja2=3.0.1 - seaborn - nibabel=3.2.1 - nilearn=0.7.1 @@ -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" \ No newline at end of file + - sphinx-inline-tabs; platform_system != "Windows" + - sphinx-book-theme; platform_system != "Windows"