Add documentation to source code through Subversion

Description

This plugin allows offline editing of wiki pages, and storage of documentation so that it is closer to the source code that it documents. It adds a Docs tab to the Trac project navigation bar. It is a wiki plugin where the wiki text is stored in the Subversion repository.

Key features:

• Uses ​RestructuredText as a markup language.
• Supports inline images and links.
• Highlights source code using ​google-code-prettify.
• Supports editing through Subversion and the Trac website.
• Handles user permission using Subversion authorization.
• Supports downloading binaries with proper mime-types for non-text files.

Source / Bugs / Feature Requests

See ​http://github.com/trac-hacks/tracdocs for more details and the source code, or to report issues or request features.

Installation

This plugin can be installed with:

$ easy_install tracdocs

Configuration

It is configured in the trac.ini file by enabling the component and configuring the path within the Subversion repository to store the wiki documents:

[components]
tracdocs.* = enabled

[docs]
root = wiki/trunk

By default, it will show the title of the directory that you are navigating. But if you create an index.txt file in the directory, it will use that instead, allowing you to put additional documentation at the top of a directory structure.

It uses the WIKI_VIEW permission to control access to the documentation pages.

Recent Changes

16397 by rjollos on 2017-03-25 09:37:00

Remove obsolete "0.9" code

7900 by mrjbq7 on 2010-04-30 03:28:20

New hack TracDocsPlugin, created by mrjbq7

(more)

Author/Contributors

Author: mrjbq7?
Maintainer: mrjbq7?
Contributors: