diff options
author | Stewart Smith <stewart@linux.vnet.ibm.com> | 2018-02-12 11:52:12 +1100 |
---|---|---|
committer | Stewart Smith <stewart@linux.vnet.ibm.com> | 2018-02-26 14:30:46 +1100 |
commit | 59d3cb4307b26c063dcdb86b8d42f59e78adaacb (patch) | |
tree | c4fdc6fcc65c1432686f50619b3e9151075b55d5 /.travis.yml | |
parent | 2e9a07f5568ebedd3ece63f58ed1d5249638b5b9 (diff) | |
download | blackbird-op-build-59d3cb4307b26c063dcdb86b8d42f59e78adaacb.tar.gz blackbird-op-build-59d3cb4307b26c063dcdb86b8d42f59e78adaacb.zip |
doc: initial sphinx-based documentation support
The release-notes script now produces Markdown compatible with
pandoc to help convert it into RST for sphinx.
Actual documentation is fairly limited currently.
We use intersphinx to link to various sub-projects' docs.
A .travis.yml file is added to build+publish documentation
when new code is pushed to github.
Signed-off-by: Stewart Smith <stewart@linux.vnet.ibm.com>
Diffstat (limited to '.travis.yml')
-rw-r--r-- | .travis.yml | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 00000000..88bc1800 --- /dev/null +++ b/.travis.yml @@ -0,0 +1,38 @@ +sudo: false +dist: trusty + +cache: + apt: true + +git: + depth: false + +addons: + apt: + packages: + - python-pip + - latexmk + - libalgorithm-diff-perl + - texlive + - texlive-latex-extra + - texlive-humanities + - texlive-generic-recommended + - graphviz + - texlive-generic-extra + + +language: python +python: + - "2.7" +install: + - "pip install -r doc/requirements.txt" +script: + - cd doc/; make latexpdf html + +deploy: + provider: pages + skip-cleanup: true + github-token: $GITHUB_TOKEN # Set in travis-ci.org dashboard, marked secure + local_dir: "doc/_build/html" + on: + branch: master |