Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
You can show your sphinx document on redmine
JavaScript Ruby Python
branch: master

This branch is 4 commits ahead of nishio-dens:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
app
config
db/migrate
doc/sphinx_plugin_document
lang
lib/tasks
sample
test
README.rdoc
init.rb

README.rdoc

Sphinx Redmine Plugin

  • You can show your sphinx documents on your redmine.

  • This plugin support Git, Mercurial and SVN.

Requirements

  • Before you use this plugin, You need to make project on your redmine, and configuration your repository.

  • This plugin compile your sphinx document using Sphinx Makefile on your repository and deploy any directory. If it cannot find Makefile, it doesn't work properly.

  • You need Settingslogic.

How to use

  1. When you install this plugin, 'Sphinx Document' Tab will be displayed on the menu bar of your Redmine Project.

  2. Click this tab, and if it work properly, you can see Sphinx Document List.

How to install

  1. To use this plugin, you need to install Settingslogic using ruby gems. (command: gem install settingslogic)

  2. Download this plugin using 'git clone git:github.com/nishio-dens/RedmineSphinxPlugin.git' command.

  3. Copy RedmineSphinxPlugin directory to 'vender/plugins' on Redmine installed directory.

  4. Copy sphinx_plugin_setting.yml.sample on RedmineSphinxPlugin/sample to config directory on redmine root directory, and change setting file name from sphinx_plugin_setting.yml.sample to sphinx_plugin_setting.yml.

  5. Restart your redmine.

Something went wrong with that request. Please try again.