Re: motor6-10

[Matt Newville <newville@cars.uchicago.edu>]

Pete,

On Wed, Nov 9, 2016 at 2:29 PM, Pete Jemian <jemian@anl.gov> wrote:

See the synApps utils module for an example:

https://github.com/EPICS-synApps/utils#html-documentation

I will apply this method to the other synApps modules.
It looks easier to maintain than publishing through gh-pages and keeps the HTML documentation in the master branch without need for the occasional merge to a gh-pages branch.

Oh, one can set up gh-pages to use the docs/ folder in the master branch (or even just the master branch) instead of a separate gh-pages branch.

I believe the separate branch was the only option for a while. Many of us still prefer this when the HTML docs are output compiled from the document source files (say RST/Sphinx or doxygen). In these cases, the master branch could have the document source files, but not the rendered result, which makes for cleaner and more meaningful diffs in the master branch when the docs are rebuilt.

As Michael suggested, a few scripts and/or a Makefile for "publish the docs" can make using gh-pages very easy.