Template repo for autobuilding nbsphinx sites
This template repository can be used as a basis for creating documentation sites that are auto-built using CircleCI.
CircleCI uses Spninx / nbSphinx to produce the a website in gh-pages from text and Jupyter notebook documents.
Jupytext is installed so that text files (.py, .md, etc) can be executed as notebooks via Jupytext.
Code execution is disabled by default in the nbsphinx configuration file (conf.py).
The .circleci/config.yml requires a personal Github token so that the site files can be pushed to the gh-pages branch of the repo.
The Github personal token can be obtained from https://github.com/settings/tokens/new, for example with the public_repo permission checked, and needs to be set as a GITHUB_PERSONAL_TOKEN environment variable associated with the appropriate CircleCI project (eg set from http://circleci.com/gh/GITUB_USER/GITHUB_PROJECT/edit#env-vars).
A reimagining of the OpenLearn Unit XXX.
Check there for rights information until I sort out boilerplate here...
To view the automatically published pages built from the pages in this repository, go to: https://GITORG.github.io/GITREPO