General Clawpack documentation and main wiki pages
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
doc Update instructions for installing with Conda. Oct 24, 2018
gallery various updates to docs for 5.5.0 Aug 25, 2018
papers/clawpack-5x Remove extra paragraph Jun 20, 2016
LICENSE
README.md update README to point to gallery/README Jun 25, 2017
rsync_doc.sh
rsync_gallery.sh added some documention in README, new rsync files Mar 20, 2017

README.md

clawpack/doc

This repository hosts contains documentation for Clawpack. By pushing html files created here to the clawpack.github.com repository, they show up automatically at http://www.clawpack.com.

The GitHub page for this repository also hosts the main wiki pages for Clawpack: https://github.com/clawpack/doc/wiki

Instructions to make Sphinx docs for local viewing::

    cd $CLAW/doc/doc              # assumes this repo is at $CLAW/doc
    export SPHINX_WEB=False       # or ok to leave unset
    make html                     # requires Sphinx
    open _build/html/index.html

To make version for clawpack.org webpages, assuming you have cloned $CLAW/clawpack.github.com from git@github.com:clawpack/clawpack.github.com.git and have push permission:

    cd $CLAW/doc/doc              # assumes this repo is at $CLAW/doc
    export SPHINX_WEB=True
    make html                     # requires Sphinx
    
    cd ..
    source rsync_doc.sh   # copies html files to $CLAW/clawpack.github.com
    
    cd $CLAW/clawpack.github.com
    git add .
    git commit
    git push       # assumes push permission to

To make gallery for local viewing / webpages, do the steps above but with doc/doc replaced by doc/gallery and rsync_doc.sh replaced by rsync_gallery.sh. Note that to do this you first have to build the gallery by running all the examples and producing plots. See documentation in doc/gallery/README.md for more details.