Sphinx and Travis Setup
This assumes that you're setting up a repository with only Sphinx (no code). If you're not doing that, you'll need to modify some stuff here, using your best judgment.
- First, you'll want to install Sphinx (
pip install sphinx) and the Read the Docs theme (
pip install sphinx_rtd_theme).
- Then, go through
sphinx-quickstart. You shouldn't need most of the plugins, but enable anything you're interested in.
conf.py, find the line
html_theme = 'alabaster'and replace it with
html_theme = 'sphinx_rtd_theme'.
- Edit any Sphinx documentation files you're interested in, then do
make htmlto check that everything runs.
- Make sure to commit, and add
- If you haven't already done so, set up the repository on GitHub, and push!
- Go to Travis, click the plus button, and flick the switch on your repository.
- Now, add the above
push.shfiles. Make sure to make
chmod u+x push.sh).
- Also, make sure to update
- Go to GitHub, Settings, and then Personal Access Tokens. Generate one that has push access to public repos (you can disable everything else).
- Make sure you have Ruby and Gem installed. Then, install the Travis gem -
gem install travis.
- In your repository root, do
travis encrypt GH_TOKEN=[paste your token here].
- Put that result in your
.travis.ymlfile, in the secure section I marked out.
- Commit! (Don't push yet)
- Now, create a
gh-pagesbranch and clear out your working directory (make sure nothing is uncommitted!).
$ git checkout --orphan gh-pages $ rm -rf *
- Add a
.nojekyllfile to instruct GitHub Pages not to use Jekyll.
$ touch .nojekyll $ git commit -am "Initial gh-pages commit."
- Send that up to GitHub with
git push -u origin gh-pages.
- Travis should start doing its thing. Voila!