EPICS Controls Argonne National Laboratory

Experimental Physics and
Industrial Control System

1994  1995  1996  1997  1998  1999  2000  2001  2002  2003  2004  2005  2006  2007  2008  2009  2010  2011  2012  2013  2014  2015  <20162017  2018  2019  2020  2021  2022  2023  2024  Index 1994  1995  1996  1997  1998  1999  2000  2001  2002  2003  2004  2005  2006  2007  2008  2009  2010  2011  2012  2013  2014  2015  <20162017  2018  2019  2020  2021  2022  2023  2024 
<== Date ==> <== Thread ==>

Subject: Re: motor6-10
From: Matt Newville <[email protected]>
To: Pete Jemian <[email protected]>
Cc: EPICS Tech Talk <[email protected]>
Date: Wed, 9 Nov 2016 16:05:44 -0600
Pete,

On Wed, Nov 9, 2016 at 2:29 PM, Pete Jemian <[email protected]> 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.


Replies:
RE: motor6-10 Mark Rivers
References:
motor6-10 梁雅翔
RE: motor6-10 Mark Rivers
Re: motor6-10 J. Lewis Muir
RE: motor6-10 Mooney, Tim M.
Re: motor6-10 Benjamin Franksen
RE: motor6-10 Mark Rivers
Re: motor6-10 Pete Jemian
Re: motor6-10 Pete Jemian

Navigate by Date:
Prev: Re: motor6-10 Pete Jemian
Next: RE: motor6-10 Mark Rivers
Index: 1994  1995  1996  1997  1998  1999  2000  2001  2002  2003  2004  2005  2006  2007  2008  2009  2010  2011  2012  2013  2014  2015  <20162017  2018  2019  2020  2021  2022  2023  2024 
Navigate by Thread:
Prev: Re: motor6-10 Pete Jemian
Next: RE: motor6-10 Mark Rivers
Index: 1994  1995  1996  1997  1998  1999  2000  2001  2002  2003  2004  2005  2006  2007  2008  2009  2010  2011  2012  2013  2014  2015  <20162017  2018  2019  2020  2021  2022  2023  2024 
ANJ, 09 Nov 2016 Valid HTML 4.01! · Home · News · About · Base · Modules · Extensions · Distributions · Download ·
· Search · EPICS V4 · IRMIS · Talk · Bugs · Documents · Links · Licensing ·