Sphinx - Python Documentation Generator

  •        5136

Sphinx is a tool that makes it easy to create intelligent and beautiful documentation for Python. It also supports C and C++. The support for other languages is in the plan. Support for multiple output formats are supported.

  • Output formats: HTML (including Windows HTML Help), LaTeX (for printable PDF versions), 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 module index
  • Code handling: automatic highlighting using the Pygments highlighter
  • Extensions: automatic testing of code snippets, inclusion of docstrings from Python modules (API docs), and more
Check out the list of sites using this product http://sphinx.pocoo.org/examples.html

http://sphinx.pocoo.org/

Tags
Implementation
License
Platform

   




Related Projects

Sphinx-dash - Sphinx (Python documentation generator) docset for Dash


Sphinx (Python documentation generator) docset for Dash

sphinx-markdown-sample - Markdown based sphinx the documentation generator sample


Markdown based sphinx the documentation generator sample

sphinx-rx - Rx schema documentation generator for Sphinx


Rx schema documentation generator for Sphinx

sphinx-mirror - A mirror of the Sphinx documentation generator.


A mirror of the Sphinx documentation generator.

manticore-ext - Python documentation generator based on Sphinx


Python documentation generator based on Sphinx



manticore - Python documentation generator based on Sphinx


Python documentation generator based on Sphinx

agiliq-sphinx-theme - A Sphinx documentation generator theme that matches the agiliq.com look


A Sphinx documentation generator theme that matches the agiliq.com look

Sphinx-theme - Sphinx documentation generator theme for Behat/Mink docs


Sphinx documentation generator theme for Behat/Mink docs

documentation - Mailgun Documentation


This Github repository represents Mailgun's documentation site, located at http://documentation.mailgun.com. The site is based on the Sphinx documentation generator for Python.To suggest changes to the documentation, please submit an Issue or Pull Request.

GradleFx-Documentation - The documentation of GradleFx in Sphinx format


The documentation of GradleFx in Sphinx format

documentation - Auto-generated documentation builds from the networkx/networkx/doc Sphinx sources.


Auto-generated documentation builds from the networkx/networkx/doc Sphinx sources.

documentation - Pika Sphinx documentation


Pika Sphinx documentation

ome-documentation - Sphinx-based documentation for the Open Microscopy Environment


Sphinx-based documentation for the Open Microscopy Environment

Documentation-Boilerplate - A sphinx documentation boilerplate for Alchemy open source projects


A sphinx documentation boilerplate for Alchemy open source projects

screen-sphinx-doc - Sphinx sources for Screen documentation


Sphinx sources for Screen documentation

sbs-sphinx-doc - Sphinx sources for SBS documentation


Sphinx sources for SBS documentation

sphinx-scmdomain - A Scheme domain for Sphinx documentation.


A Scheme domain for Sphinx documentation.

sphinx-lua - Lua domain for Sphinx documentation builder


Lua domain for Sphinx documentation builder

sphinx-theme-minimalism - A simple Sphinx theme inspired by Flasks documentation


A simple Sphinx theme inspired by Flasks documentation

sphinx-docs - Sphinx is a tool that makes it easy to create intelligent and beautiful documentation.


Sphinx is a tool that makes it easy to create intelligent and beautiful documentation.