Suggestions for documentation generation?

Collapse
This topic is closed.
X
X
Collapse
 
  • Page of 1
  • Time
  • Show
Clear All
new posts
Previous template Next
  • kpd
    #1

    Suggestions for documentation generation?

    Hello,

    I have written a C++ library that I've then wrapped with Pyrex.
    Any suggestions to the best-in-class tool to create documentation for
    the libraries?

    I would love to document things in one spot (could be the code) and
    generate html and PDF from there.

    Doxygen (www.doxygen.org) looks to be about the best so far.

    Thanks,

    Tags: None
    • John M. Gabriele
      #2
      Re: Suggestions for documentation generation?

      kpd wrote:[color=blue]
      > Hello,
      >
      > I have written a C++ library that I've then wrapped with Pyrex.
      > Any suggestions to the best-in-class tool to create documentation for
      > the libraries?
      >
      > I would love to document things in one spot (could be the code) and
      > generate html and PDF from there.
      >
      > Doxygen (www.doxygen.org) looks to be about the best so far.
      >
      > Thanks,
      >[/color]

      I've heard that some folks use pythondoc:
      http://starship.python.net/crew/danilo/pythondoc/

      http://effbot.org/zone/pythondoc.htm


      There's also HappyDoc http://happydoc.sourceforge.net/
      and EpyDoc http://epydoc.sourceforge.net/ .

      --
      (remove zeez if demunging email address)

        Comment

        • Terry Hancock
          #3
          Re: Suggestions for documentation generation?

          On Wed, 01 Mar 2006 19:58:50 -0500
          "John M. Gabriele" <john_sips_teaz @yahooz.com> wrote:[color=blue]
          > kpd wrote:[color=green]
          > > I have written a C++ library that I've then wrapped with
          > > Pyrex. Any suggestions to the best-in-class tool to
          > > create documentation for the libraries?
          > >
          > > I would love to document things in one spot (could be
          > > the code) and generate html and PDF from there.
          > >
          > > Doxygen (www.doxygen.org) looks to be about the best so
          > > far.[/color]
          >
          > I've heard that some folks use pythondoc:
          > http://starship.python.net/crew/danilo/pythondoc/
          > http://effbot.org/zone/pythondoc.htm
          >
          > There's also HappyDoc http://happydoc.sourceforge.net/
          > and EpyDoc http://epydoc.sourceforge.net/ .[/color]

          Those are great, but I don't think they handle C++ ;-)

          Which makes me wonder -- will epydoc work on a pyrex or
          C-extension file if it defines the __doc__ strings?

          --
          Terry Hancock (hancock@Anansi Spaceworks.com)
          Anansi Spaceworks http://www.AnansiSpaceworks.com

            Comment

            • kpd
              #4
              Re: Suggestions for documentation generation?

              Thanks - I took at both. Also at 'percepts', which I used a long time
              ago (had forgotten about it). Percepts has a great little java applet
              for viewing the class hierarchy. I don't think it works for python,
              just C++ though. Looks like doxygen will fit the bill.

                Comment

                • Michael Ekstrand
                  #5
                  Re: Suggestions for documentation generation?

                  On 2 Mar 2006 04:06:17 -0800
                  "kpd" <kevin.dahlhaus en@gmail.com> wrote:[color=blue]
                  > Thanks - I took at both. Also at 'percepts', which I used a long time
                  > ago (had forgotten about it). Percepts has a great little java applet
                  > for viewing the class hierarchy. I don't think it works for python,
                  > just C++ though. Looks like doxygen will fit the bill.[/color]

                  An excellent choice IMHO.

                  Doxygen has recently added support for Python, so if there is
                  pure-Python code interfacing with the rest of your work, that can be
                  documented also.

                  - Michael

                  --
                  mouse, n: a device for pointing at the xterm in which you want to type.
                  -- Fortune

                    Comment

                    • John M. Gabriele
                      #6
                      Re: Suggestions for documentation generation?

                      Michael Ekstrand wrote:[color=blue]
                      >
                      >
                      > Doxygen has recently added support for Python, [snip][/color]

                      Didn't know that. Thanks for the heads-up. :)

                      --
                      (remove zeez if demunging email address)

                        Comment

                        • Bo Peng
                          #7
                          Re: Suggestions for documentation generation?

                          kpd wrote:[color=blue]
                          > Hello,
                          >
                          > I have written a C++ library that I've then wrapped with Pyrex.
                          > Any suggestions to the best-in-class tool to create documentation for
                          > the libraries?
                          >
                          > I would love to document things in one spot (could be the code) and
                          > generate html and PDF from there.
                          >
                          > Doxygen (www.doxygen.org) looks to be about the best so far.
                          >
                          >[/color]

                          I was facing the same problem and took the following approach:

                          1. write c++ code with doxygen-complaint comments
                          2. generate XML comments using doxygen
                          3. parse XML and generate Python docstring
                          4. insert the docstring into SWIG interface file

                          I can send you the parser but I do not know if pyrex support python
                          docstring.

                          Bo

                            Comment

                            Previous template Next
                            Working...