Merge pull request #446 from choldgraf/docs_theme

adding circleci preview and jupyterhub docs theme
pull/451/head
Min RK 2018-10-18 13:51:57 +02:00 zatwierdzone przez GitHub
commit a8fc5395c3
Nie znaleziono w bazie danych klucza dla tego podpisu
ID klucza GPG: 4AEE18F83AFDEB23
3 zmienionych plików z 47 dodań i 1 usunięć

Wyświetl plik

@ -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

Wyświetl plik

@ -1,2 +1,4 @@
sphinx>=1.4, !=1.5.4
recommonmark
alabaster
alabaster_jupyterhub

Wyświetl plik

@ -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