PDoc turns the source code comments into Ruby objects which can then ben passed into any kind of documentation generator.
Currently, the only written generator is for a static HTML website. But PDoc was built keeping in mind other formats would be highly desirable. Shoot me an email if you'd be interested in helping out with writing the DocBook generator. Best, Tobie On Jan 6, 3:13 pm, Richard Quadling <rquadl...@googlemail.com> wrote: > 2010/1/6 Tobie Langel <tobie.lan...@gmail.com>: > > > > > > > Erh... but the documentation IS the website. > > > And DocBook support is planned. Maybe you'd like to help with it? > > > Best, > > > Tobie > > > On Jan 6, 11:43 am, Richard Quadling <rquadl...@googlemail.com> wrote: > >> 2010/1/5 Tobie Langel <tobie.lan...@gmail.com>: > > >> > Yes. > > >> > Or you can use coderay instead, but I haven't included a stylesheet > >> > for that yet. > > >> > We choose pygments as it's already the default for github and Jekyll. > > >> > Thought this consistency might end up being useful. > > >> > Also Pygment's a real lexer. > > >> > Best, > > >> > Tobie > > >> > On Jan 5, 12:00 pm, Richard Quadling <rquadl...@googlemail.com> wrote: > >> >> 2010/1/5 Tobie Langel <tobie.lan...@gmail.com>: > > >> >> > Hi Richard. > > >> >> > You'll have to use another syntax highlighter ATM or build the > >> >> > documentation without syntax highlighting. > > >> >> > To do so, just modify the rake task like so: > > >> >> >http://gist.github.com/266858 > > >> >> > Hope this helps. > > >> >> > Best, > > >> >> > Tobie > > >> >> > (Also, a patch to make pygments work on windows would be absolutely > >> >> > awesome!) > > >> >> > On Jan 4, 2:50 pm, Richard Quadling <rquadl...@googlemail.com> wrote: > >> >> >> Hi. > > >> >> >> Using open4 on Windows seems to be an issue. > > >> >> >> (in D:/Personal > >> >> >> Files/Downloads/Software/Programming/Javascript/prototype) > >> >> >> mkdir -p D:/Personal > >> >> >> Files/Downloads/Software/Programming/Javascript/prototype/test/unit/tmp > >> >> >> rm -rf D:/Personal > >> >> >> Files/Downloads/Software/Programming/Javascript/prototype/doc > > >> >> >> Parsing source files: D:/Personal > >> >> >> Files/Downloads/Software/Programming/Javascript/prototype/test/unit/tmp/pro > >> >> >> totype.temp.js. > >> >> >> Parsing completed in 46.735 seconds. > > >> >> >> Generating documentation to: D:/Personal > >> >> >> Files/Downloads/Software/Programming/Javascript/prototype/doc. > > >> >> >> rake aborted! > >> >> >> uninitialized constant Fcntl::F_SETFD > >> >> >> D:/Personal > >> >> >> Files/Downloads/Software/Programming/Javascript/prototype/rakefile:75:in > >> >> >> `build_doc_for' > >> >> >> (See full trace by running task with --trace) > > >> >> Isn't Pygments python? Do I need to have Python as well now? > > >> >>http://pygments.org/docs/lexers/ > > >> >> -- > >> >> ----- > >> >> Richard Quadling > >> >> "Standing on the shoulders of some very clever giants!" > >> >> EE :http://www.experts-exchange.com/M_248814.html > >> >> Zend Certified Engineer > >> >> :http://zend.com/zce.php?c=ZEND002498&r=213474731 > >> >> ZOPA :http://uk.zopa.com/member/RQuadling > > >> > -- > >> > You received this message because you are subscribed to the Google > >> > Groups "Prototype: Core" group. > >> > To post to this group, send email to prototype-core@googlegroups.com > >> > To unsubscribe from this group, send email to > >> > prototype-core-unsubscr...@googlegroups.com > >> > For more options, visit this group > >> > athttp://groups.google.com/group/prototype-core?hl=en > > >> I think I'll skip all of this and use the website instead. > > >> I'd much rather have DocBook V5 orientated documentation. > > >> But then the dox wouldn't be inline. > > >> Swings and roundabouts. > > >> -- > >> ----- > >> Richard Quadling > >> "Standing on the shoulders of some very clever giants!" > >> EE :http://www.experts-exchange.com/M_248814.html > >> Zend Certified Engineer :http://zend.com/zce.php?c=ZEND002498&r=213474731 > >> ZOPA :http://uk.zopa.com/member/RQuadling > > > -- > > You received this message because you are subscribed to the Google Groups > > "Prototype: Core" group. > > To post to this group, send email to prototype-core@googlegroups.com > > To unsubscribe from this group, send email to > > prototype-core-unsubscr...@googlegroups.com > > For more options, visit this group > > athttp://groups.google.com/group/prototype-core?hl=en > > Is that generating DocBook XML from the source code comments? Or > starting from scratch and create the XML files directly? > > -- > ----- > Richard Quadling > "Standing on the shoulders of some very clever giants!" > EE :http://www.experts-exchange.com/M_248814.html > Zend Certified Engineer :http://zend.com/zce.php?c=ZEND002498&r=213474731 > ZOPA :http://uk.zopa.com/member/RQuadling
-- You received this message because you are subscribed to the Google Groups "Prototype: Core" group. To post to this group, send email to prototype-core@googlegroups.com To unsubscribe from this group, send email to prototype-core-unsubscr...@googlegroups.com For more options, visit this group at http://groups.google.com/group/prototype-core?hl=en
