Skip to content

Commit 06a0b82

Browse files
committed
build and deploy docs on travis-ci.com
- See https://docs.travis-ci.com/user/deployment/pages/ - add docs badge to README - close #4
1 parent 524afdd commit 06a0b82

3 files changed

Lines changed: 42 additions & 0 deletions

File tree

.travis.yml

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
language: python
2+
cache: pip
3+
sudo: false
4+
5+
python:
6+
- "3.6"
7+
8+
branches:
9+
only:
10+
- master
11+
12+
env:
13+
global:
14+
- secure:
15+
16+
install:
17+
- if [[ $TRAVIS_PYTHON_VERSION == "3.6" ]]; then pip install --upgrade sphinx sphinx-sitemap; fi
18+
- pip install -e .
19+
20+
script:
21+
- true
22+
23+
after_success:
24+
# only need to build docs on 3.6 version
25+
# touch .nojekyll else github-pages messes up theme
26+
- if [[ $TRAVIS_PYTHON_VERSION == "3.6" ]]; then python setup.py build_sphinx && touch ./build/sphinx/html/.nojekyll; fi
27+
28+
deploy:
29+
# stuff related to deploying to gh-pages
30+
# GUTHUB_TOKEN is set in Travis-CI settings (@orbeckst)
31+
provider: pages
32+
skip_cleanup: true
33+
github_token: $GITHUB_TOKEN
34+
on:
35+
branch: master
36+
python: "3.6"
37+
local_dir: build/sphinx/html
38+
project_name: MDAnalysisData

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
99

1010
### Added
1111
- documentation (#4)
12+
- automatic deployment of docs to
13+
https://www.mdanalysis.org/MDAnalysisData/ via Travis-CI (#4)
1214

1315

1416
## [0.2.0] - 2018-10-04

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
# MDAnalysisData
2+
3+
[![docs](https://img.shields.io/badge/docs-latest-brightgreen.svg)](https://www.mdanalysis.org/MDAnalysisData/)
24
[![DOI](https://zenodo.org/badge/147885122.svg)](https://zenodo.org/badge/latestdoi/147885122)
35

46
Access to data for workshops and extended tests of MDAnalysis.

0 commit comments

Comments
 (0)