Profouzors
/
boxespy
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

create travis build script for doc 

Edited by Florian Festi
This commit is contained in:
Rotzbua 2018-10-03 06:11:42 +02:00 committed by Florian Festi
parent fe89528e05
commit 21172a592f
4 changed files with 47 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
.travis.yml Normal file
View File

@ -0,0 +1,29 @@
language: python
python:
- "2.7"
# Cache PlatformIO packages using Travis CI container-based infrastructure
sudo: false
cache:
- pip
branches:
only:
- master
install:
- pip install sphinx pycairo
script:
#- python setup.py install
- cd ./documentation/src/ && make html #linkchecker
- cd ../build/ && ls && ls html/
- rm -rf doctrees
- touch .nojekyll
deploy:
provider: pages
# see https://docs.travis-ci.com/user/deployment/pages/
skip-cleanup: true
github-token: $GITHUB_TOKEN # Set in the settings page of your repository, as a secure variable
keep-history: true
local-dir: ./documentation/build/
on:
branch: master

3
documentation/src/Makefile
View File

@ -3,7 +3,7 @@
# You can set these variables from the command line. # You can set these variables from the command line.
SPHINXOPTS = SPHINXOPTS =
SPHINXBUILD = sphinx-build-3 SPHINXBUILD = sphinx-build
PAPER = PAPER =
BUILDDIR = ../build BUILDDIR = ../build
@ -51,6 +51,7 @@ clean:
html: html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
cp index.html $(BUILDDIR)/
@echo @echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html." @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

1
documentation/src/conf.py
View File

@ -36,6 +36,7 @@ extensions = [
'sphinx.ext.coverage', 'sphinx.ext.coverage',
'sphinx.ext.ifconfig', 'sphinx.ext.ifconfig',
'sphinx.ext.viewcode', 'sphinx.ext.viewcode',
'sphinx.ext.githubpages',
] ]
# Add any paths that contain templates here, relative to this directory. # Add any paths that contain templates here, relative to this directory.

15
documentation/src/index.html Normal file
View File

@ -0,0 +1,15 @@
<!DOCTYPE HTML>
<html lang="en-US">
<head>
<meta charset="UTF-8">
<meta http-equiv="refresh" content="0;url=html/index.html">
<script type="text/javascript">
window.location.href = "html/index.html"
</script>
<title>Page Redirection</title>
</head>
<body>
<!-- Note: don't tell people to `click` the link, just tell them that it is a link. -->
If you are not redirected automatically, follow the <a href='html/index.html'>link to example</a>
</body>
</html>