From 4c50efe6acdc0ce80aeb33fcf5345509cfa97ecf Mon Sep 17 00:00:00 2001 From: Chris Holdgraf Date: Wed, 17 Oct 2018 20:57:22 -0700 Subject: [PATCH] adding circle and jupyterhub docs theme --- .circleci/config.yml | 42 +++++++++++++++++++++++++++++++++++++++ docs/doc-requirements.txt | 2 ++ docs/source/conf.py | 4 +++- 3 files changed, 47 insertions(+), 1 deletion(-) create mode 100644 .circleci/config.yml diff --git a/.circleci/config.yml b/.circleci/config.yml new file mode 100644 index 00000000..470e0f56 --- /dev/null +++ b/.circleci/config.yml @@ -0,0 +1,42 @@ +version: 2 +jobs: + # Define a "build_docs" job to be run with Circle + build_docs: + # This is the base environment that Circle will use + docker: + - image: circleci/python:3.6-stretch + steps: + # Get our data and merge with upstream + - run: sudo apt-get update + - checkout + # Update our path + - run: echo "export PATH=~/.local/bin:$PATH" >> $BASH_ENV + # Restore cached files to speed things up + - restore_cache: + keys: + - cache-pip + # Install the packages needed to build our documentation + # This will depend on your particular package! + - run: pip install --user -r docs/doc-requirements.txt + # Cache some files for a speedup in subsequent builds + - save_cache: + key: cache-pip + paths: + - ~/.cache/pip + # Build the docs + - run: + name: Build docs to store + command: | + cd docs + make html + # Tell Circle to store the documentation output in a folder that we can access later + - store_artifacts: + path: docs/build/html/ + destination: html + +# Tell CircleCI to use this workflow when it builds the site +workflows: + version: 2 + default: + jobs: + - build_docs diff --git a/docs/doc-requirements.txt b/docs/doc-requirements.txt index fe185f28..dea73e15 100644 --- a/docs/doc-requirements.txt +++ b/docs/doc-requirements.txt @@ -1,2 +1,4 @@ sphinx>=1.4, !=1.5.4 recommonmark +alabaster +alabaster_jupyterhub \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py index af81bb96..cc48fea0 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -96,7 +96,9 @@ html_favicon = '_static/images/favicon.ico' # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = 'alabaster' +import alabaster_jupyterhub +html_theme = 'alabaster_jupyterhub' +html_theme_path = [alabaster_jupyterhub.get_html_theme_path()] # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the