https://github.com/callaghanmt-training/comp2211-xv6
Science Score: 13.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
○.zenodo.json file
-
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (10.0%) to scientific vocabulary
Repository
Basic Info
- Host: GitHub
- Owner: callaghanmt-training
- Language: Shell
- Default Branch: main
- Size: 87.9 KB
Statistics
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
- Releases: 0
Metadata Files
README.md
A template jupyter book documentation repository
This is a template repository that can be used when generating documentation using Jupyter-books and hosting the site via GitHub pages.
Working with this project locally
You can get this project working locally by using the environment.yml file to create a conda environment that contains all the dependencies required to get started.
```{bash} $ git clone https://github.com/ARCTraining/template-jb-docs.git
$ conda env create -f environment.yml ```
To build the html content locally you can use the jupyter-book command line tool:
```{bash}
navigate to the repository root
$ cd template-jb-docs
sometimes worth running jupyter-book clean book/ to remove old files
$ jupyter-book build book/ ```
Windows
An important note is that the JupyterBook project does not currently support Windows (see here for more).
To aid with this we have created a Vagrantfile that can allow Windows users who have a virtualisation provider installed (such as VirtualBox) and Vagrant installed to create a headless virtual Linux machine that will build the jupyter book. You can do this with the following steps once you've installed a virtualisation provider and vagrant:
```
within git-bash or powershell
$ cd template-jb-docs $ vagrant up
to rebuild the site after changes with the vagrant box running
$ vagrant reload --provision
don't forget to destroy the box when you're done
$ vagrant destroy ```
This will build the jupyter-book html files on your Windows file system (by navigating via /vagrant) so your local build will still persist after you've destroyed your vagrant box.
Owner
- Name: callaghanmt-training
- Login: callaghanmt-training
- Kind: organization
- Repositories: 1
- Profile: https://github.com/callaghanmt-training
GitHub Events
Total
Last Year
Dependencies
- actions/checkout v2 composite
- goanpeca/setup-miniconda v1 composite
- peaceiris/actions-gh-pages v3.6.1 composite
- ghp-import *
- jupyter-book *