Closed jputrino closed 8 years ago
Looks like my changing 'doc' to 'docs' broke the build. We'll need to either update the make file or change the name back, up to you @swormke.
Probably want to make sure that .gitignore
includes the docs/_build
directory.
done -- JP
We should add a line to the .travis.yml
file that will also build the docs. I know this won't deploy them, but it would be good to see that the building of the docs isn't broken. You can add a line like the following to the end of the script:
section.
script:
- cd docs; make html
done - JP
It is probably also a good idea to add a requirements.docs.txt
file to the repo that installs all the stuff you need to build the docs with. It may only contain one line for now Sphinx==1.3.5
you can see what this is in your virtualenv by doing pip freeze | grep Sphinx
. Once you have this you can install that file prior to building in the install
section of the .travis.yml
file. For example:
install:
- pip install -r requirements.docs.txt
done -- JP
Fixes #13 @swormke
What's this change do?
Where should the reviewer start?
Review conf.py to make sure everything looks like it's set up correctly.
Any background context?
I built the files locally and they looked ok; once this PR is merged, I'll import the project into RTD.