Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Python documentation in wiki-like environment (with some autodoc features) [closed]

I have investigated, and have high hopes for, sphinx.

However, it doesn't do everything I want in a documentation framework. Here's what I'm looking for:

  • A wiki-like (ie, web-editable) environment with revision tracking
  • Support for autodoc (ie importing of docstrings, etc.)
  • (ideally) a connector to version management so that the code can be browsed from earlier revisions

Does any such thing exist?

like image 653
jMyles Avatar asked Jun 13 '26 20:06

jMyles


1 Answers

GitHub's Gollum which is a "A simple, Git-powered wiki with a sweet API and local frontend" could be a possible solution. It supports reStructured Text, which as you probably know, is the same markup used by Sphinx.

like image 183
jathanism Avatar answered Jun 16 '26 22:06

jathanism



Donate For Us

If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!