[cctbxbb] cctbx documentation

[markus.gerstel at diamond.ac.uk]

Dear Paul,

We are currently already generating Sphinx documentation for xia2 and dials using our buildserver. The pages are then pushed to (and served from) github repositories, ie. https://xia2.github.io and https://dials.github.io.
Using the same setup for cctbx would be trivial. In fact, I've just added it to the list, and the automatically built documentation is now available at https://cctbx.github.io
Hosting the documentation itself in a git repository would have the advantage that it can be easily mirrored to other webservers and, with a bit of digging, one can get to the documentation of historic versions.

(If you do not like this idea, the page can be removed as quickly as it was created.)

Best wishes,
-Markus


-----Original Message-----
From: cctbxbb-bounces at phenix-online.org [mailto:cctbxbb-bounces at phenix-online.org] On Behalf Of Paul Adams
Sent: 11 October 2015 21:28
To: cctbxbb at phenix-online.org
Subject: [cctbxbb] cctbx documentation

Dear Colleagues,

  we are looking at the cctbx documentation. Currently the world is directed to the documentation on the Sourceforge site, which hasn’t been updated for a long time and is looking somewhat old. Last year, Oliver and Ian (and others) worked on Sphinx-based documentation for cctbx (the last published version of which can be found here: http://cci.lbl.gov/cctbx_docs/). The question for the cctbx developer community therefore is whether we should move over to the Sphinx system for cctbx documentation. The benefits are: a more consistent and modern interface, and automated documentation generation from source code header file information. As part of making this move we would need to integrate some of the additional information from the original cctbx site into the Sphinx documentation. We would also move the hosting of the cctbx documentation to the CCI web server in Berkeley (and off the Sourceforge site). Another email related to that topic soon.
  I’d appreciate any feedback on this topic.

  Cheers,
	Paul

--
Paul Adams
Interim Division Director, Molecular Biophysics & Integrated Bioimaging, Lawrence Berkeley Lab Division Deputy for Biosciences, Advanced Light Source, Lawrence Berkeley Lab Adjunct Professor, Department of Bioengineering, U.C. Berkeley Vice President for Technology, the Joint BioEnergy Institute Laboratory Research Manager, ENIGMA Science Focus Area

Building 33, Room 347
Building 80, Room 247
Building 978, Room 4126
Tel: 1-510-486-4225, Fax: 1-510-486-5909 http://cci.lbl.gov/paul

Lawrence Berkeley Laboratory
1 Cyclotron Road
BLDG 33R0345
Berkeley, CA 94720, USA.

Executive Assistant: Louise Benvenue [ LBenvenue at lbl.gov ][ 1-510-495-2506 ]
--















_______________________________________________
cctbxbb mailing list
cctbxbb at phenix-online.org
http://phenix-online.org/mailman/listinfo/cctbxbb

-- 
This e-mail and any attachments may contain confidential, copyright and or privileged material, and are for the use of the intended addressee only. If you are not the intended addressee or an authorised recipient of the addressee please notify us of receipt by returning the e-mail and do not use, copy, retain, distribute or disclose the information in or attached to the e-mail.
Any opinions expressed within this e-mail are those of the individual and not necessarily of Diamond Light Source Ltd. 
Diamond Light Source Ltd. cannot guarantee that this e-mail or any attachments are free from viruses and we cannot accept liability for any damage which you may sustain as a result of software viruses which may be transmitted in or with the message.
Diamond Light Source Limited (company no. 4375679). Registered in England and Wales with its registered office at Diamond House, Harwell Science and Innovation Campus, Didcot, Oxfordshire, OX11 0DE, United Kingdom