Feedback

X
Sphinx Python Documentation Generator: Documentation

Sphinx Python Documentation Generator: Documentation

9 Ungluers have Faved this Work

Sphinx is a tool that makes it easy to create intelligent and beautiful documentation, written by Georg Brandl and licensed under the BSD license.

It was originally created for the new Python documentation, and it has excellent facilities for the documentation of Python projects, but C/C++ is already supported as well, and it is planned to add special support for other languages as well. Of course, this site is also created from reStructuredText sources using Sphinx! The following features should be highlighted:

  • Output formats: HTML (including Windows HTML Help), LaTeX (for printable PDF versions), ePub, Texinfo, manual pages, plain text
  • Extensive cross-references: semantic markup and automatic links for functions, classes, citations, glossary terms and similar pieces of information
  • Hierarchical structure: easy definition of a document tree, with automatic links to siblings, parents and children
  • Automatic indices: general index as well as a language-specific module indices
  • Code handling: automatic highlighting using the Pygments highlighter
  • Extensions: automatic testing of code snippets, inclusion of docstrings from Python modules (API docs), and more
  • Contributed extensions: more than 50 extensions contributed by users in a second repository; most of them installable from PyPI

Read online at sphinx-doc.org

Why read this book? Have your say.

You must be logged in to comment.

Rights Information

Are you the author or publisher of this work? If so, you can claim it as yours by registering as an Unglue.it rights holder.

Downloads

This work has been downloaded 436 times via unglue.it ebook links.
  1. 142 - mobi (OSI) at Internet Archive.
  2. 156 - pdf (OSI) at Internet Archive.
  3. 138 - epub (OSI) at Internet Archive.

Keywords

  • Computers
  • Computers / Document Management
  • Documentation
  • Python (Computer program language)

Links

web: http://www.sphinx-doc.org/en/stable/

Editions

edition cover

Share

Copy/paste this into your site: