Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move documentation build to circleci #2509

Merged
merged 2 commits into from Mar 6, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
37 changes: 37 additions & 0 deletions .circleci/config.yml
@@ -0,0 +1,37 @@
apt-run: &apt-install
name: Install apt packages
command: |
sudo apt update
sudo apt install -y graphviz

pip-run: &pip-install
name: Install Python dependencies
command: |
python3 -m venv venv
. venv/bin/activate
pip install -r requirements/docs.txt

version: 2
jobs:
build:
environment:
- MAIN_CMD: "venv/bin/python setup.py"
- SETUP_CMD: "build_docs -w"
docker:
- image: circleci/python:3.6
steps:
- checkout
- run: *apt-install
- run: *pip-install
- run: $MAIN_CMD $SETUP_CMD

- store_artifacts:
path: docs/_build/html

- run:
name: "Built documentation is available at:"
command: DOCS_URL="${CIRCLE_BUILD_URL}/artifacts/${CIRCLE_NODE_INDEX}/${CIRCLE_WORKING_DIRECTORY/#\~/$HOME}/docs/_build/html/index.html"; echo $DOCS_URL

notify:
webhooks:
- url: https://giles.cadair.com/circleci
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What is this?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Look at the Ci status! It provides a link to the documentation build.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OH this link provides that.

4 changes: 0 additions & 4 deletions .travis.yml
Expand Up @@ -82,10 +82,6 @@ matrix:
env: MAIN_CMD="py.test"
SETUP_CMD="--remote-data -k-figure --cov --cov-config sunpy/tests/coveragerc ./docs/"

- python: 3.6
stage: Comprehensive tests
env: SETUP_CMD='build_docs -w'

# Python 2.7 (implicit astropy 2)
- python: 2.7
stage: Comprehensive tests
Expand Down
2 changes: 1 addition & 1 deletion requirements/docs.txt
Expand Up @@ -6,4 +6,4 @@

sphinx
sunpy-sphinx-theme
sphinx-gallery
git+https://github.com/sphinx-gallery/sphinx-gallery