Modify

Opened 6 years ago

Last modified 5 years ago

#4740 new enhancement

Accessing the doxygen files in a subversion repository

Reported by: anonymous Owned by: cboos
Priority: normal Component: DoxygenPlugin
Severity: normal Keywords: doxygen subversion
Cc: rjollos Trac Release: 0.11

Description

As documentation should be part of a project, we commit our doxygen HTML documentation to the subversion repository too. What we do now is to checkout this files on the server in an extra directory to let the doxygen plugin have access to them. The subversion directory could be mounted as WebDAV filesystem, but this means much administration efford too. This means a couple of management and administration, so it would be desirable and highly convenient to access the files directly in the subversion repository. So instead of /var/lib/path/to/doxygen/doc something like svn:trunk/doc/html could then be configured.

Unfortunately I don't know python (I looked at the sources and understood nothing), so I ask you to realize this enhancement.

Thank you in advance!

Attachments (0)

Change History (5)

comment:1 Changed 6 years ago by anonymous

  • Cc ryano@… added; anonymous removed

comment:2 Changed 6 years ago by anonymous

  • Type changed from defect to enhancement

comment:3 Changed 6 years ago by anonymous

I don't think this is necessary. Manually maintaining the documentation like this is not ideal and takes a lot of time. Try this method instead:

  1. On the machine hosting Subversion/Trac, checkout the repository that you are interested in documenting into a local working directory.
  2. Create a post-commit script that updates the above working directory and generates the Doxygen documentation (in the background, if possible).

Because the documentation will be generated when the commit is successful, you can be sure that you are always serving the latest/greatest documentation.

comment:4 Changed 6 years ago by anonymous

  • Cc rjollos added; ryano@… removed

comment:5 Changed 5 years ago by lucasrangit

Instead of a post-commit hook I use Bitten and the following build recipe to generate the latest doxygen documentation and then rsync's them to the SVN host at a location the DoxygenPlugin for Trac is configured to look.

<build xmlns:svn="http://bitten.cmlenz.net/tools/svn"
       xmlns:sh="http://bitten.cmlenz.net/tools/sh">
  <step id="checkout" description="Checkout source from repository">
    <svn:checkout url="https://svn/project/"
        path="${path}" revision="${revision}" />
  </step>
  <step id="build" description="Compile">
    <sh:exec executable="doxygen" args=".doxyfile" /> 
  </step>
  <step id="rsync" description="Update Trac Doxygen">
    <sh:exec executable="rsync" args="-rvz --delete /var/local/doxygen/project/ svn@svn:/var/local/doxygen/project" /> 
  </step>
</build>

Add Comment

Modify Ticket

Action
as new The owner will remain cboos.
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.