[Qgis-psc] QGIS documentation work

[Tim Sutton]

Hi Guys

Could you give me a little update on the current status so that I can report back at the next meeting in 1.5 weeks time?

Thanks!

Regards

Tim
> On 14 Mar 2016, at 09:49, Martin Dobias <martin.dobias at lutraconsulting.co.uk> wrote:
> 
> Hi all
> 
> Sorry for the delayed reply, I have been offline until yesterday.
> 
> 
> On 9.3.2016 05:39, Tim Sutton wrote:
>> Thanks for your patience. I’m copying you all in so that you can virtually ‘meet’ each other. I met with the PSC last night and the way forward is agreed. My proposal is that we share the work between the three of you (with the possibility of pulling in two other applicants if they are willing and we need more help). 
> Thanks Tim for bringing up your proposal to PSC to get the project going!
> 
>> The idea is that we form a small team (the four of us for now). The first priority would be to establish the main workflows for what we want to build which Martin would do with some input from the rest of us as needed. Martin has been looking at the possibility of using Breath[1] Then Martin would step back a bit and Wes and Francisco could start wading with the actual documentation work. How does that sound for all of you?
> Sounds good!
> 
> I would like to finish the research on Breathe, possibly contributing to it for the bits we will find necessary. For those who have not heard about Breathe - it acts as a bridge between Doxygen and Sphinx - if everything will work well, we should be able to get the best of both worlds - comprehensive API docs generated from source code with the power and look of Sphinx docs used for the rest of QGIS documentation, allowing a complete blend of API docs with the python cookbook.
> 
>> Assuming we are agreed, we can get started, first with Martin designing the standard approach. The PSC has earmarked 5000 EURO of QGIS funds for the API documentation work which is not a huge fortune, but if we make a success of it I think we will be able to access further funding (e.g. via a funding drive) further down the line. I would expect the funding split to be somewhere along the lines of 1000 EUR for the initial pilot work and then 4000 EURO for the writing API documentation.
> Cool!
> 
>> I also do need to sensitise you to the fact that the API is going to undergo some big revisions for QGIS 3.0 so you will need to work closely with the dev community to ensure that your work is focussed on areas of the code that are not going to e.g. get axed in the near future.
> I think the best would be if we make a list of important classes missing good docs and keep an eye as we progress on those which are likely to change significantly in the run towards 3.0.
> 
> 
> I shall be able to fit in the work on docs starting from April.
> 
> For Wes and Francisco - as of now I am (mostly) in GMT+8 timezone, which is a bit of difference from yours, but that should not be an issue for the collaboration :-)
> 
> Cheers
> Martin
> 
> 
> 
> This email and any files transmitted with it are confidential and intended solely for the use of the individual or entity to whom they are addressed. If you have received this email in error please notify the system manager. This message contains confidential information and is intended only for the individual named. If you are not the named addressee you should not disseminate, distribute or copy this e-mail. Please notify the sender immediately by e-mail if you have received this e-mail by mistake and delete this e-mail from your system. If you are not the intended recipient you are notified that disclosing, copying, distributing or taking any action in reliance on the contents of this information is strictly prohibited.
> 
> Whilst reasonable care has been taken to avoid virus transmission, no responsibility for viruses is taken and it is your responsibility to carry out such checks as you feel appropriate.
> 
> If this email contains a quote or offer to sell products, carry out work or perform services then our standard terms and conditions <http://www.lutraconsulting.co.uk/downloads/Lutra%20Consulting%20Standard%20Terms%20and%20Conditions.pdf> shall apply unless explicitly stated otherwise.
> 
> Saber Razmjooei and Peter Wells trading as Lutra Consulting.
> 
> 
> 




---

Tim Sutton
QGIS Project Steering Committee Chair
tim at qgis.org




-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/qgis-psc/attachments/20160327/f2dc991f/attachment.html>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: qgis_icon.jpg
Type: image/jpeg
Size: 4642 bytes
Desc: not available
URL: <http://lists.osgeo.org/pipermail/qgis-psc/attachments/20160327/f2dc991f/attachment.jpg>