Quantcast

Sphinx(Python documentation generator)

Sphinx(Python documentation generator) wiki, Sphinx(Python documentation generator) review, Sphinx(Python documentation generator) history, Sphinx(Python documentation generator) motto, Sphinx(Python documentation generator) ownership Sphinx(Python documentation generator) news, what is Sphinx(Python documentation generator) Sphinx(Python documentation generator) wikipedia
Sphinx(Python documentation generator) designer, Sphinx(Python documentation generator) sales, Sphinx(Python documentation generator) facts

Sphinx[2][3]​ 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 Python documentation, and it has excellent facilities for the documentation of software projects in a range of languages. Of course, this site is also created from reStructuredText sources using Sphinx!

Features

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

Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.

 

All information for Sphinx(Python documentation generator)'s wiki comes from the below links. Any source is valid, including Twitter, Facebook, Instagram, and LinkedIn. Pictures, videos, biodata, and files relating to Sphinx(Python documentation generator) are also acceptable encyclopedic sources.
This is a discussion about Sphinx(Python documentation generator). Concerns about the topic, its accuracy, inclusion of information etc. should be discussed here. Off-topic discussion not pertaining to Sphinx(Python documentation generator) or this wiki will be removed.
Other wiki pages related to Sphinx(Python documentation generator).
Created: 05/05/2018 04:34:44 PM UTC
Last Modified: 05/05/2018 04:40:40 PM UTC