Difference between revisions of "Sphinx"

From Free Software Directory
Jump to: navigation, search
(Created page with "{{Entry |Name=Sphinx |Short description=Python documentation generator. |Full description=Sphinx is a tool that makes it easy to create intelligent and beautiful documentation fo...")
 
m (version 1.2.3)
Line 3: Line 3:
 
|Short description=Python documentation generator.
 
|Short description=Python documentation generator.
 
|Full description=Sphinx is a tool that makes it easy to create intelligent and beautiful documentation for Python projects (or other documents consisting of multiple reStructuredText sources), written by Georg Brandl. It was originally created to translate the new Python documentation, but has now been cleaned up in the hope that it will be useful to many other projects. 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.
 
|Full description=Sphinx is a tool that makes it easy to create intelligent and beautiful documentation for Python projects (or other documents consisting of multiple reStructuredText sources), written by Georg Brandl. It was originally created to translate the new Python documentation, but has now been cleaned up in the hope that it will be useful to many other projects. 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.
 +
|Homepage URL=http://sphinx-doc.org/
 
|User level=intermediate
 
|User level=intermediate
|Status=Live
+
|VCS checkout command=hg clone https://bitbucket.org/birkenfeld/sphinx
|Component programs=
 
|Homepage URL=http://sphinx.pocoo.org/
 
|VCS checkout command=
 
 
|Computer languages=Python
 
|Computer languages=Python
|Documentation note=http://sphinx.pocoo.org/contents.html
+
|Documentation note=http://sphinx-doc.org/contents.html
|Paid support=
+
|IRC help=irc://irc.freenode.net/sphinx-doc
|IRC help=
+
|IRC general=irc://irc.freenode.net/sphinx-doc
|IRC general=
+
|IRC development=irc://irc.freenode.net/sphinx-doc
|IRC development=
 
 
|Related projects=Rusty
 
|Related projects=Rusty
 
|Keywords=documentation conversion,documentation,Python,document,document conversion,documentation tools
 
|Keywords=documentation conversion,documentation,Python,document,document conversion,documentation tools
|Is GNU=n
+
|Version identifier=1.2.3
|Last review by=Kelly Hopkins
+
|Version date=2014-09-01
|Last review date=2010-03-25
+
|Version status=stable
 +
|Version download=https://pypi.python.org/packages/source/S/Sphinx/Sphinx-1.2.3.tar.gz
 +
|Last review by=Genium
 +
|Last review date=2014-09-14
 
|Submitted by=Database conversion
 
|Submitted by=Database conversion
 
|Submitted date=2011-04-01
 
|Submitted date=2011-04-01
|Version identifier=0.6.5
+
|Status=
|Version date=2010-03-01
+
|Is GNU=No
|Version status=beta
 
|Version download=http://pypi.python.org/packages/source/S/Sphinx/Sphinx-0.6.5.tar.gz#md5=86dd5dbd55cb44d1f8091a4a1c3743b2
 
 
|License verified date=2010-03-25
 
|License verified date=2010-03-25
|Version comment=
 
}}
 
{{Person
 
|Role=Maintainer
 
|Real name=Georg Brandl
 
|Email=georg@python.org
 
|Resource URL=
 
}}
 
{{Resource
 
|Resource audience=Developer
 
|Resource kind=Homepage
 
|Resource URL=http://pypi.python.org/pypi/Sphinx
 
}}
 
{{Software category
 
|Documentation-tool=documentation-conversion
 
|Interface=console,web
 
|Text-creation=documentation-tool
 
|Use=text-creation
 
|Works-with=text
 
 
}}
 
}}
 
{{Project license
 
{{Project license
Line 71: Line 50:
 
|License verified date=2010-03-25
 
|License verified date=2010-03-25
 
}}
 
}}
 +
{{Person
 +
|Real name=Georg Brandl
 +
|Role=Maintainer
 +
|Email=georg@python.org
 +
|Resource URL=
 +
}}
 +
{{Resource
 +
|Resource audience=Developer
 +
|Resource kind=Homepage
 +
|Resource URL=http://pypi.python.org/pypi/Sphinx
 +
}}
 +
{{Software category
 +
|Documentation-tool=documentation-conversion
 +
|Interface=console, web
 +
|Text-creation=documentation-tool
 +
|Use=text-creation
 +
|Works-with=text
 +
}}
 +
{{Featured}}

Revision as of 04:44, 14 September 2014


[edit]

Sphinx

http://sphinx-doc.org/
Python documentation generator.

Sphinx is a tool that makes it easy to create intelligent and beautiful documentation for Python projects (or other documents consisting of multiple reStructuredText sources), written by Georg Brandl. It was originally created to translate the new Python documentation, but has now been cleaned up in the hope that it will be useful to many other projects. 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.





Licensing

License

Verified by

Verified on

Notes

Verified by

Kelly Hopkins

Verified on

25 March 2010

License

Python

Verified by

Kelly Hopkins

Verified on

25 March 2010

License

Expat

Verified by

Kelly Hopkins

Verified on

25 March 2010

Verified by

Kelly Hopkins

Verified on

25 March 2010

License

BSD

Verified by

Kelly Hopkins

Verified on

25 March 2010




Leaders and contributors

Contact(s)Role
Georg Brandl Maintainer


Resources and communication

AudienceResource typeURI
Ruby (Ref)https://rubygems.org/gems/sphinx
Debian (Ref)https://tracker.debian.org/pkg/sphinx
Python (Ref)https://pypi.org/project/Sphinx


Software prerequisites




Entry































Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the page “GNU Free Documentation License”.

The copyright and license notices on this page only apply to the text on this page. Any software or copyright-licenses or other similar notices described in this text has its own copyright notice and license, which can usually be found in the distribution or license text itself.