IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity
899 Commits 2 Branches 219 Tags
e2c52d6e906d84a931df32b2e5e34976775ab69b
Go to file
Clone
Open with VS Code Open with VSCodium Open with Intellij IDEA
Download ZIP Download TAR.GZ Download BUNDLE
Georg Brandl e2c52d6e90 Fix #77: If a description environment with info field list only 
contains one ``:param:`` entry, no bullet list is generated.
2008-12-28 20:02:55 +01:00
doc
Due to popular demand, added a `:doc:` role which directly
2008-12-28 19:44:54 +01:00
sphinx
Fix #77: If a description environment with info field list only
2008-12-28 20:02:55 +01:00
tests
Fix test_autodoc after return annotation change.
2008-12-28 19:44:10 +01:00
utils
Merged revisions 64808,65013,65076,65100-65101,65119,65121-65123 via svnmerge from
2008-07-18 22:55:36 +00:00
.hgignore
Add TAGS.
2008-11-16 09:16:17 +01:00
AUTHORS
Armin deserves special mention.
2008-01-11 14:21:06 +00:00
babel.cfg
Add translation of strings in JavaScript files.
2008-09-06 17:36:25 +00:00
CHANGES
Fix #77: If a description environment with info field list only
2008-12-28 20:02:55 +01:00
EXAMPLES
Add MapServer.
2008-12-27 12:22:18 +01:00
ez_setup.py
Update ez_setup.py.
2008-11-23 19:50:56 +01:00
LICENSE
Explicitly refer to the license in :license: tags.
2008-12-27 12:19:17 +01:00
Makefile
Merged revisions 65566-65567,65623,65625 via svnmerge from
2008-08-10 16:59:27 +00:00
MANIFEST.in
Use * instead of *.* as glob pattern, catches Makefile.
2008-11-04 19:51:38 +01:00
README
Fix #53, a few nits in the README.
2008-11-24 20:33:58 +01:00
setup.cfg
Add i18n support, thanks to Horst Gutmann.
2008-08-08 10:54:00 +00:00
setup.py
Add text output format.
2008-11-23 19:13:15 +01:00
sphinx-build.py
Explicitly refer to the license in :license: tags.
2008-12-27 12:19:17 +01:00
sphinx-quickstart.py
Explicitly refer to the license in :license: tags.
2008-12-27 12:19:17 +01:00
TODO
change tracker url
2008-11-04 02:34:12 +01:00

README 

=================
README for Sphinx
=================

Installing
==========

Use ``setup.py``::

   python setup.py build
   sudo python setup.py install


Reading the docs
================

After installing::

   cd doc
   sphinx-build . _build/html

Then, direct your browser to ``_build/html/index.html``.

Or read them online at <http://sphinx.pocoo.org/>.


Contributing
============

Send wishes, comments, patches, etc. to sphinx-dev@googlegroups.com.
Description
The Sphinx documentation generator
docsdocumentationdocumentation-toolmarkdownpythonrestructuredtextsphinx
Readme 125 MiB
Languages
Python 79.5%
JavaScript 11.5%
TeX 5.6%
Jinja 2.5%
HTML 0.6%
Other 0.2%