Guide for updating this documentation

See also the README.md at https://github.com/clawpack/doc.

When updating the documentation for a new release, see also Guide for doing a Clawpack release.

The clawpack/doc repository is not included in the Clawpack distribution and must be cloned separately if you want to work with these files.

After cloning into the $CLAW directory, the restructured text files for the main documentation are in $CLAW/doc/doc. All files related to the gallery are in $CLAW/doc/gallery. As of Version 5.4.1, these two subdirectories are separate Sphinx projects connected using intersphinx. This is so that past versions of the main documentation pages can be supported without past versions of the galleries.

The general look of the documentation and various things that appear on each page are controlled by the following files:

  • conf.py includes the version number, sets the html_theme, as well as setting paths to extensions and various other sphinx settings.
  • _themes/flask_local/layout.html determines the menus at the top
  • _themes/flask_web/layout.html version used for building for the web, is the same except for different relative link to the galleries.
  • _static/clawlogo.jpg is the Clawpack logo put on each page
  • _static/clawicon.ico is the icon that appears on browser tabs

Before proceeding, first make sure other repositories are checked out to master, since some pages now have literalinclude’s that bring in code (e.g. setaux_defaults.rst, etc).

To create html files:

cd $CLAW/doc/doc
make html

To view the files, point your browser to $CLAW/doc/doc/_build/html/index.html

To generate pages with old Clawpack versions

This should be done when you are close to pushing changes to the website, otherwise the above approach works fine and shows the current state of the documentation based on files in your working directory.

This takes much longer than make html since it rebuilds pages for all versions.

The instructions below make webpages that list v5.4.0, etc. and allow viewing docs that may be more relevant to a previous version of Clawpack.

But note that the .rst files used to build these pages come form what is checked into the v5.x.x branch on Github (and the commits corresponding to tags such as v5.4.0). So if you have changed .rst files but these have not yet been merged into v5.x.x or dev on Github, you will not see the changes reflected in the html files you build.

To make pages that show previous Clawpack versions, first install the sphinx extension via:

pip install -U sphinx
pip install sphinxcontrib-versioning

and then do this:

cd $CLAW/doc/doc
export SPHINX_WEB=False # to build for local viewing
sphinx-versioning build -i -r v5.x.x doc ./_build/html
    # change v5.x.x to the current version

Note that -i causes versions to be listed in reverse order at the bottom, -r v5.x.x uses the v5.x.x branch for the main landing page, and doc is the directory containing the .rst files relative to the top directory of the Git repository. Only .rst files that are checked into Git on some branch at origin are seen.

To view the files, point your browser to $CLAW/doc/doc/_build/html/v5.x.x/index.html (with 5.x.x replaced by the current version).

If you like what you see, you can push back to your fork and then issue a pull request to have these changes incorporated into the documentation.

Note: To make versions where the links to the gallery work properly after the pages are pushed to the Clawpack website (but not locally), set the environment variable SPHINX_WEB to True in the above steps. This variable is used in conf.py to adjust the links used in intersphinx_mapping since two sphinx projects are linked together.

Updating the webpages

A few developers can push html files to the repository clawpack/clawpack.github.com which causes them to show up on the web at http://clawpack.github.io.

To do so, first create the html files as described above, with SPHINX_WEB=True in both the doc and gallery directories.

Commit any changed source files and push to clawpack/doc.

Then do:

cd $CLAW/clawpack.github.com
git checkout v5.x.x
git pull origin  # make sure you are up to date before doing next steps!

cd $CLAW/doc/doc
rsync -azv _build/html/ ../../clawpack.github.com/

If you have updated the gallery, also do:

rsync -azv ../gallery/_build/html/ ../../clawpack.github.com/gallery/

Then move to the clawpack.github.com repository and add and commit any new or changed files. All files are needed, so

cd $CLAW/clawpack.github.com
git add .

should work. For the commit message you might want to add the commit hash of the most recent commit in $CLAW/doc/doc:

cd $CLAW/clawpack.github.com
git add .
git commit -m "changes from doc/doc commit <hash>"

And finally push to the web:

git push origin

which assumes that origin is git@github.com:clawpack/clawpack.github.com.git.

It may take a few minutes for the updated webpages to appear at http://clawpack.github.io/.

Note that http://clawpack.org and http://www.clawpack.com should also resolve properly to http://clawpack.github.io/. and that www.clawpack.org should appear in the browser address bar. The file extra_files/CNAME combined with settings on the domain server godaddy.com determine this behavior.

Extra files for webpages not built by Sphinx

Any files placed in $CLAW/doc/doc/extra_files will be copied verbatim (recursively for subdirectories) to the directory $CLAW/doc/doc/_build/html when Sphinx is used to build the documentation. These will be copied to $CLAW/clawpack.github.com/ when the rsync_clawpack.github.sh script is run and hence will appear on the webpages.

For example, the file $CLAW/doc/doc/extra_files/clawdev2013/index.html should appear at http://www.clawpack.org/clawdev2013/index.html.

The files in $CLAW/doc/doc/extra_files/links provide redirects so that links like http://www.clawpack.org/links/an11 resolve properly to webpages on the University of Washington server. Links of this nature have been provided in published paper and some contain large amounts of data that have not been copied to Github.