patchCERTI - Patches: patch #6862, Add semi-automatic doc generation...

 
 

You are not allowed to post comments on this tracker with your current authentication level.

patch #6862: Add semi-automatic doc generation for PyHLA

Submitter:  Eric NOULARD <erk>
Submitted:  Thu 09 Jul 2009 06:57:45 PM UTC
   
 
Category:  PyHLA Priority:  5 - Normal
Status:  Ready For Test Privacy:  Public
Assigned to:  erk Open/Closed:  Closed

Mon 13 Jul 2009 10:32:11 AM UTC, comment #5: 

I did miss the howto target.
It's fine no problem.
Thanks

Eric NOULARD <erk>
Group administrator
Sun 12 Jul 2009 07:36:51 PM UTC, comment #4: 

Hi Eric,

Great script! Many thanks. I've added it to CVS.

The ADD_CUSTOM_TARGET is always executed while ADD_CUSTOM_COMMAND can be executed only if some source changes. I think it's much better. Or would you prefer to keep ADD_CUSTOM_TARGET?

There is now a new target "howto" that builds all documentation. It's similar to the way how CERTI doc is built. (I updated the documentation accordingly.)


Petr

Petr Gotthard <gotthardp>
Group Member
Sun 12 Jul 2009 05:06:07 PM UTC, comment #3: 

Hi Petr,

Here comes a new patch (which should work on the current HEAD tree).

I did add a small CMake script in order to ease
the download of msc.sty (instead of putting it in the CVS)
using CMake FILE(DOWNLOAD ...)

I did add some doc regarding UAV in the tex file.

I have question, why did you transform the ADD_CUSTOM_TARGET
into ADD_CUSTOM_COMMAND? 
Which target(s) build the doc now?




(file #18415)

Eric NOULARD <erk>
Group administrator
Fri 10 Jul 2009 05:19:51 PM UTC, comment #2: 

Yes I agree with that policy,
however sometimes when the dependency is not that huge I do add external source to a CVS tree,
mainly in order to ease installation.

The msc.sty looks like a great candidate because:
  - it is not in standard TeXlive distro
  - this is just one file
  - the LPPL license seems OK
    (I need to read it more carefully though)

Another solution would be to ease automate
its download using CMake. I may try that for fun.

Eric NOULARD <erk>
Group administrator
Fri 10 Jul 2009 05:08:08 PM UTC, comment #1: 

Thank you, Eric.

I have integrated the CMakeFiles.txt changes, but I'm not sure if I want to add the msc.sty into the PyHLA CVS. It's a 3rd party software and I believe that CVS should store original source codes only.

Petr Gotthard <gotthardp>
Group Member
Thu 09 Jul 2009 06:57:45 PM UTC, original submission:  

I think we can systematically add the rules
for generating PyHLA documentation since they
must be explicitely launch.

i.e. simple "make" won't trigger them
one need to call

make PyHLA.html
and/or
make PyHLA.dvi
and/or
make PyHLA.pdf


Eric NOULARD <erk>
Group administrator

 

(Note: upload size limit is set to 16384 kB, after insertion of the required escape characters.)

Attached Files
file #18415:  PyHLAdoc-2.patch added by erk (7KiB - text/x-diff - more auto-doc)
file #18398:  PyHLAdoc.patch added by erk (115KiB - text/x-diff - The patch itself)

 

Depends on the following items: None found

Items that depend on this one: None found

 

Carbon-Copy List
  • -email is unavailable- added by gotthardp (Posted a comment)
  • -email is unavailable- added by erk (Submitted the item)
  •  

    There are 0 votes so far. Votes easily highlight which items people would like to see resolved in priority, independently of the priority of the item set by tracker managers.

     

    Follow 5 latest changes.

    Date Changed by Updated Field Previous Value => Replaced by
    2009-10-21 erk Assigned toNone erk
        Open/ClosedOpen Closed
    2009-07-13 gotthardp StatusWorks For Me Ready For Test
    2009-07-12 erk Attached File- Added PyHLAdoc-2.patch, #18415
    2009-07-09 erk Attached File- Added PyHLAdoc.patch, #18398

    Back to the top

    Powered by Savane 3.13-4b48.
    Corresponding source code