Re: [DOC-SIG] Status of documentation effort?
There has never been a coordinated doc-sig effort started for automated documentation generation ala gendoc. Currently gendoc has been patched to work in 1.5 by it's author Daniel Larsson. I have wanted to start one though. Hopefully recent interest indicates that we would get some substantial efforts from folks on this list should we start one. So...
The list looks very good. Regarding the winhelp renderer, it is very likely this wont be needed with the new MS "htmlhelp" stuff. I'll try and look into this and see what the impact is. But my main point of writing is to outline one of my key requirements before I could move to gendoc full-time. I really, really, really would like a technique for defining cross-references in the documentation strings. At the moment URL's are OK, but it is nigh on impossible to have "func1" contain a documentation cross-reference to "func2" - there is no URL for "func2" - it is being generated by the same process doing func1. My main objective is to replace all of the "winhelp" documentation I have with "gendoc" generated. However, most of the existing winhelp documentation is formatted as a "reference guide", and cross-references are an absolute necessity. Unfortunately, this is not as trivial as it sounds - but it is not too hard either. Is there general support for a feature like this? [I did make some hacks to gendoc to support this, but the patches were too wide-reaching for me to post back, and no one else except me really seemed to care about this feature...] Mark. _______________ DOC-SIG - SIG for the Python Documentation Project send messages to: doc-sig@python.org administrivia to: doc-sig-request@python.org _______________
So, anyone got a decent URI scheme for Python elements? Preferably something that will handle: fully-qualified (universally valid) URI's... something like /mcf/pars/andgrp#AndGrp.consume /mcf/pars/andgrp /mcf/pars/orgrp#OrGrp Basically, should be able to say: from mcf.pars.andgrp import AndGrp and then get the correct attribute off AndGrp? Requires that the processing script know the sys.path under which the files will be processed, that is, the script needs to know what the root of the hierarchy is for the sets of relative URI's (context sensitive)... something like #OrGrp.posopt_consume # in same module ./orgrp#OrGrp.consume # method in module in same package ../utils#dummy # module in sibling package consume # method of class OrGrp OrGrp.consume # class method of module orgrp orgrp # module of package pars ...yada catching broken links (optional) These obviously aren't the perfect URI schemes, anyone have any better ones? We would want them to be easily typed, and hopefully easily recognised both by the code reader and the system. Well, off to sleep, enjoy all, Mike ________________________________ M i k e C . F l e t c h e r mcfletch@golden.net http://www.golden.net/~mcfletch/ ________________________________ Design, Consultation, Training _______________ DOC-SIG - SIG for the Python Documentation Project send messages to: doc-sig@python.org administrivia to: doc-sig-request@python.org _______________
participants (2)
-
Mark Hammond -
Mike Fletcher