The repository here contains HTML (and document sources) for http://software.es.net/. This file provides information deemed useful when committing changes to that page.
The rendering infrastructure for software.es.net is based on what's in the esnet-gh-pages-base repo, and the software dependencies are in fact the same. Primarily this means installing Sphinx, a Python documentation tool. The Sphinx installation steps below are copied from the esnet-gh-pages-base documentation:
sudo /usr/bin/easy_install pip
sudo /usr/local/bin/pip install sphinx sphinx-bootstrap-theme
sudo port install python27 py27-pip py27-sphinx
sudo port select pip py27-pip
sudo port select sphinx py27-sphinx
pip install sphinx sphinx-bootstrap-theme
In general, building the HTML and previewing works the same as for any other ESnet software project using the esnet-gh-pages-base infrastructure.
A major difference between this repo and project documentation sites is that for project documentation sites, the document sources live in a subdirectory on the master branch and get deployed to the gh-pages branch of the repo. For this repo, the document sources live in the page-source branch of this repo and they get deployed to the master branch.
git clone [email protected]:esnet/esnet.github.io.git
git branch page-source
- Edit
docs/index.rst
. This file is in ReStructured Text format (see http://www.sphinx-doc.org/en/stable/rest.html for details). make html
- Preview the result at
_build/html/index.html
(the MacOS open command will open this page in the default Web browser) - Commit and push the changes to the page sources.
- To deploy, make a tarball of the HTML tree:
tar -c -C docs/_build/html -f /tmp/software.tar .
- Switch back to the master branch with
git branch master
- Unpack the tarball you just made:
tar -xvf /tmp/software.tar
- Commit and push the deployed HTML pages. After this point they'll show up (shortly?) at http://software.es.net/. Note: It is not necessary (and probably not even desirable) to add .buildinfo as a new file.