search

slaclab / anarel-manage

Manage the conda based analysis release environments that include psana at LCLS.
Other
3 stars 3 forks source link

automate documentation generation #44

Open davidslac opened 7 years ago

davidslac commented 7 years ago

We made /reg/g/psdm/sw/conda/web

then we have

ana-releases ana-releases/psana-conda-1.2.7

and web/ana -> ana-releases/psana-conda-1.2.7

in psana-conda-1.2.7, we need to generate a index.hml, that is a table with links to the checked in documentation, for pacakges, like PyDataSource --> /reg/g/psdm/sw/conda/scratch/psana-conda-1.2.7/PyDataSource/doc/build/html

davidslac commented 7 years ago

@slacmshankar Hi Murali, @koglin and I are mapping out where to put documentation, we need to host

we want

pswww/something/doc

to be a pointer to this

/reg/g/psdm/sw/conda/web

eventually it will have a index.html, but for now it is mainly for the link

ana -> psana-conda current documentation,

anyways, this is work in progress

davidslac commented 7 years ago

Murali pointed out that we already have this in the file system

(ana-1.2.7) (psreldev) psel701: /reg/g/psdm/web/swdoc/releases $ ls -l
total 9
lrwxrwxrwx  1 psrel xs 58 Nov  4 07:16 LogBookClient -> /reg/g/pcds/pyps/apps/LogBookClient/latest/docs/build/html
lrwxrwxrwx  1 psrel xs 38 Sep 25  2013 ana-0.10.0 -> /reg/g/psdm/sw/releases/ana-0.10.0/doc
lrwxrwxrwx  1 psrel xs 37 May  6  2011 ana-0.3.5 -> /reg/g/psdm/sw/releases/ana-0.3.5/doc
lrwxrwxrwx  1 psrel xs 37 Feb  9  2012 ana-0.4.5 -> /reg/g/psdm/sw/releases/ana-0.4.5/doc
lrwxrwxrwx  1 psrel xs 37 Feb 15  2012 ana-0.4.6 -> /reg/g/psdm/sw/releases/ana-0.4.6/doc
lrwxrwxrwx  1 psrel xs 37 May 15  2013 ana-0.9.8 -> /reg/g/psdm/sw/releases/ana-0.9.8/doc
lrwxrwxrwx  1 psrel xs 39 May  6  2011 ana-current -> /reg/g/psdm/sw/releases/ana-current/doc
lrwxrwxrwx  1 psrel xs 35 Aug  4  2012 current -> /reg/g/psdm/sw/releases/current/doc
lrwxrwxrwx  1 psrel xs 29 Mar 14 15:33 detrot -> /reg/g/pcds/pyps/swdoc/detrot
lrwxrwxrwx  1 psrel xs 28 Feb  8 09:55 happi -> /reg/g/pcds/pyps/swdoc/happi
lrwxrwxrwx  1 psrel xs 27 Mar 30 13:46 pedl -> /reg/g/pcds/pyps/swdoc/pedl
drwxr-xr-x 10 psrel xs 19 Jun 11  2012 psana
lrwxrwxrwx  1 psrel xs 36 Oct  3  2016 psp -> /reg/g/pcds/pkg_mgr/release/psp/docs

so maybe we should just change ana-current, or add a ana-conda-current, to point into our conda/web stuff

for instance one has this nice page http://pswww.slac.stanford.edu/swdoc/releases/psp/