Review Request 127747: Create a new script that generate the documentation for all projects following the syntax I proposed

[Olivier Churlaud]

> On May 20, 2016, 3:50 a.m., Michael Pyne wrote:
> > I've looked at the code itself and it seems reasonable, so from that perspective and given the length of time there's been no -1's, I think it's safe to commit.
> > 
> > However you mentioned in the description that this isn't safe to commit to master. I have no clue how we generate apidox for KF5 and Plasma 5 so I'm not sure what you mean when you say we'd affect the currents script. What is your plan for integrating this without breaking the scripts? Is there work needed by others (sysadmin, EBN, etc.) to make apidox generation work with your patch committed? What's the action KDE developers must take after this, if any?
> 
> Olivier Churlaud wrote:
>     Thank you for the review Michel. The only need will be to update the metainfo.yml. I can do that for the frameworks if needed after commiting. Or I can even do this before so that it doesn't break.
>     
>     Commit plan:
>     1) update frameworks metainfo (they are back-compatibles but the *new* script will break with the old metainfo.
>     2) commit in master
>     3) See if everything works as expected else correct.
>     4) Clean up the code and teach it new tricks ; Add other projects that the frameworks.
> 
> Olivier Churlaud wrote:
>     Oh and maybe the current folder containing the html pages should be removed as well.

I forgot something. The name of the script will change. So I have to either see with a sysadmin to change the cronjob or overright the previous one.


- Olivier


-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
https://git.reviewboard.kde.org/r/127747/#review95632
-----------------------------------------------------------


On April 25, 2016, 11:49 p.m., Olivier Churlaud wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> https://git.reviewboard.kde.org/r/127747/
> -----------------------------------------------------------
> 
> (Updated April 25, 2016, 11:49 p.m.)
> 
> 
> Review request for KDE Frameworks, Albert Astals Cid, Alex Merry, Aurélien Gâteau, and Allen Winter.
> 
> 
> Repository: kapidox
> 
> 
> Description
> -------
> 
> Keep in mind that it should not plainly replace kgenframeworks but be used by all KDE projects. So in this proposition, the Frameworks are just one project in others.
> 
> The code can be tested directly by checking the branch `olivier/generate_all_repos`.
> 
> This MUST NOT be merged in master, because it will break the currents scripts (see commit 3643dded7cf14a5634879e8e6e34be8840143d7e).
> 
> 
> Diffs
> -----
> 
>   konqi_frameworks.png PRE-CREATION 
>   metainfo.yaml 4ff17c8 
>   metainfo_syntax.md PRE-CREATION 
>   src/kapidox/data/htmlresource/default_product.png PRE-CREATION 
>   src/kapidox/data/htmlresource/kde.css b864ef5 
>   src/kapidox/data/templates/doxygen2.html PRE-CREATION 
>   src/kapidox/data/templates/frontpage.html PRE-CREATION 
>   src/kapidox/data/templates/libinfo.html PRE-CREATION 
>   src/kapidox/data/templates/maintainers.html PRE-CREATION 
>   src/kapidox/data/templates/subgroup.html PRE-CREATION 
>   src/kapidox/generator.py 5b8ae40 
>   src/newkapidox.py PRE-CREATION 
>   src/notes PRE-CREATION 
> 
> Diff: https://git.reviewboard.kde.org/r/127747/diff/
> 
> 
> Testing
> -------
> 
> Tested on various scenario cases.
> 
> 
> File Attachments
> ----------------
> 
> This is an example of what I generated. (Threadweaver is duplicated and modified to test different scenarios)
>   https://git.reviewboard.kde.org/media/uploaded/files/2016/04/25/2e4549e4-7c17-416c-9a72-b82d3bba18b3__doc.tar.gz
> 
> 
> Thanks,
> 
> Olivier Churlaud
> 
>

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mail.kde.org/pipermail/kde-frameworks-devel/attachments/20160520/add0ff02/attachment.html>