Argonne National Laboratory

Experimental Physics and
Industrial Control System

2002  2003  2004  2005  2006  2007  2008  2009  2010  2011  2012  2013  2014  <20152016  2017  Index 2002  2003  2004  2005  2006  2007  2008  2009  2010  2011  2012  2013  2014  <20152016  2017 
<== Date ==> <== Thread ==>

Subject: Generated documentation inside Base
From: Ralph Lange <Ralph.Lange@gmx.de>
To: EPICS Core-Talk <core-talk@aps.anl.gov>
Date: Wed, 21 Jan 2015 17:35:47 +0100
All,

As we move the Record Reference Manual from Wiki to being embedded in EPICS Base, we need two things:

  1. An index page for the record documentation.
    This could use local links for records that have been converted, and links to the Wiki for all other record types.
  2. A way to push the generated docs onto APS (or other) web space.
    It would be nice to have an on-line version of these docs (or better: one for each released version of Base and the current development version).


For 1., I would think a static page should be fine. Things will be rarely changing, and I don't know if it is worth adding the complexity of an indexing script.
For 2., I could imagine an APS Jenkins job that pushes the docs for the current version. Released versions would probably still need manual intervention/upload.

Any thoughts?

~Ralph


Replies:
Re: Generated documentation inside Base Andrew Johnson

Navigate by Date:
Prev: Re: Build failed in Jenkins: epics-base-3.15-cyg64 #177 Andrew Johnson
Next: Re: Generated documentation inside Base Andrew Johnson
Index: 2002  2003  2004  2005  2006  2007  2008  2009  2010  2011  2012  2013  2014  <20152016  2017 
Navigate by Thread:
Prev: Re: Jenkins build is back to normal : epics-base-3.15-cyg64 #190 Andrew Johnson
Next: Re: Generated documentation inside Base Andrew Johnson
Index: 2002  2003  2004  2005  2006  2007  2008  2009  2010  2011  2012  2013  2014  <20152016  2017 
ANJ, 16 Dec 2015 Valid HTML 4.01! · Home · News · About · Base · Modules · Extensions · Distributions · Download ·
· EPICS V4 · IRMIS · Talk · Bugs · Documents · Links · Licensing ·