#3279 Sphinx Trac Plugin Install Fails
Closed: Fixed None Opened 11 years ago by edhelms.

= bug description =
Attempting to install the Sphinx Trac plugin does not appear to work. The Katello team would like to use this plugin so that we can create and store our documentation in our repository using rST and Sphinx to generate the docs. This plugin can be found here - http://pypi.python.org/pypi/TracSphinx/0.2.1

= bug analysis =

= fix recommendation =
Either fix the ability to install this particular Trac plugin via the web admin interface or provide this as a plugin for all projects to easily toggle on or off.


We would be happy to make this plugin available, but it needs to be packaged up in Fedora/EPEL before we can do so.

I'll see if I can find someone interested in packaging it up...

In addition to the plugin, this requires http://pypi.python.org/pypi/sphinx.webtools/0.2.1 to be installed to work.

Reviews for both are up and passed:

https://bugzilla.redhat.com/show_bug.cgi?id=821890

https://bugzilla.redhat.com/show_bug.cgi?id=821889

We are under a freeze right now, but can likely install them after that's over (when f17 is released).

ok. I have them installed now...

In order to get this working, I think I have to add:

[sphinx]
source_dir = /path/to/docs

Whats the path you want to have your docs at?

Hum, we ran into an issue with this plugin.

It's overriding 'site' in python apps. :(

I'll look at a fix.

RE: docs path

The docs would live at the root of our git tree under docs/ at http://git.fedorahosted.org/git/?p=katello.git;a=tree. I should note, that does not exist on the master branch as of yet, since we are planning to move towards the docs in our repository but needed to make sure it could be supported first. If any help is needed on my end to resolve issues surrounding the integration with fedorahosted please let me.

This is super old. I am going to close it out now.

If there's still desire for this plugin, please reopen and we can revisit.

Login to comment on this ticket.

Metadata