Sphinx SoC potential projects
Note: please contact us in irc.freenode.net #pocoo about details for all ideas and more coordination regarding your application.
Note: not all of these ideas are "large" enough to fill the whole summer. They should be used as starting points or to be combined.
- Port Sphinx to Python 3.
- Writing a Sphinx web app that serves docs in a more interactive fashion than the standard static HTML. This would be used for the Python docs and should include comments, better search (e.g. via Xapian) and changes suggestions, but other feature suggestions are welcome if students come up with them. NOTE: This has been the project of SoC 2009, and the implementation is quite far. However, it is not finished and integrating the branch with the newest trunk, as well as making all proposed features work (see http://tosh.pl/gminick/gsoc/sphinx/index.htm), would be a very important task for the project and can e.g. combined very well with the Python 3 porting.
- The LLVM people have a proposal for a Sphinx-related project:
"We currently use doxygen for our source code documentation, which has a number of limitations. We would love to see tools like Pygments or Sphinx adopt Clang as a way to get exceptional C++ support and be the basis of a better system for documenting C++ code. Extending the Clang Python bindings to support Pygments and Sphinx plugins would be another great project." See http://socghop.appspot.com/gsoc/org/show/google/gsoc2010/llvm for contact info.
- Adding a MediaWiki output builder.
- Integrate Doxygen with Sphinx.
- Use the S5 writer in docutils to create an S5 builder for Sphinx, to enable creating modular slide shows (each source file would be a "section" of the slide show, with its own "title" slide).
- Figure out a convenient way to translate a Sphinx documentation set, e.g. via a web application, and to keep that translation updated, and to serve them in a multilingual way, statically and/or dynamically.