This repository contains the source materials for the University of Washington Professional and Continuing Education Program Python Certification Program:
Certificate in Python Programming <https://www.pce.uw.edu/certificates/python-programming>_
These materials will be available in html rendered version here:
https://uwpce-pythoncert.github.io/PythonCertDevel220/
These documents are written in Restructured Text <http://docutils.sourceforge.net/rst.html>, and rendered with the Sphinx Documentation system <http://www.sphinx-doc.org/>.
To build the docs, you need Python, Sphinx, and sphinx-rtd-theme::
pip3 install -r requirements.txt
Should do it.
Building the docs locally: ..........................
in the main dir, run::
make html
The html docs will be generated in the build/html dir --
build/html/index.html is the main page.
Building the docs for uploading to gh-pages ...........................................
The html docs are published by gitHub's gh-pages. This is accomplished by putting all the html in the gh-pages branch of the repo.
YOu can do that by hand, by copying any new html to the branch, but if you want to do it more often, it's easier to automate it.
There is a bash script that will do it for you: build_gh_pages.sh.
It requires a bit of setup:
make another clone of this repo "next to" the main clone (i.e. in the same dir), but name that clone: "PythonCertDevel.gh-pages".
checkout the gh-pages branch in that clone::
git checkout gh-pages
it's a good idea to do a pull once to make sure you are up to date:
git pull
Once this is setup, you can run the build_gh_pages script from the name repo, and it should:
Once run, the new version of the docs should be published on gitHub at:
https://uwpce-pythoncert.github.io/PythonCertDevel/
NOTE: build_gh_pages is a pretty hacky script with limited functionality -- in particular, it does not clear out any old files that have been removed. If you remove a page, it must be removed by hand from the gh-pages branch. PRs welcome.