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
1,015 Commits 2 Branches 219 Tags
4e3c3a43fcf35bf110cd35ebe53ee54ac1720ae1
Go to file
Clone
Open with VS Code Open with VSCodium Open with Intellij IDEA
Download ZIP Download TAR.GZ Download BUNDLE
Georg Brandl 4e3c3a43fc The new `trim_footnote_reference_space` config value mirrors 
the docutils config value of the same name and removes the
space before a footnote reference that is necessary for reST
to recognize the reference.
2009-01-26 23:38:02 +01:00
doc
The new `trim_footnote_reference_space` config value mirrors
2009-01-26 23:38:02 +01:00
sphinx
The new `trim_footnote_reference_space` config value mirrors
2009-01-26 23:38:02 +01:00
tests
Add a minimal test for external toctree links and fix a small bug found by it.
2009-01-26 22:04:29 +01:00
utils
Some more license nits.
2009-01-03 12:15:04 +01:00
.hgignore
Ignore .so files.
2008-12-30 02:37:01 +01:00
AUTHORS
Added a toctree variable to the templates, and the ability to
2009-01-26 21:57:15 +01:00
babel.cfg
Switched templating to jinja2
2008-11-20 20:05:45 +01:00
CHANGES
The new `trim_footnote_reference_space` config value mirrors
2009-01-26 23:38:02 +01:00
EXAMPLES
Add WTForms.
2009-01-26 20:08:02 +01:00
ez_setup.py
Update ez_setup.py.
2008-11-23 19:50:56 +01:00
LICENSE
Add JQuery license; add PSF copyright statement.
2009-01-05 00:04:53 +01:00
Makefile
Merged revisions 65566-65567,65623,65625 via svnmerge from
2008-08-10 16:59:27 +00:00
MANIFEST.in
Add Grammar.txt to Manifest.
2009-01-06 00:38:40 +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
Automated merge with http://bitbucket.org/birkenfeld/sphinx
2008-11-27 00:32:38 +01:00
sphinx-build.py
Some more license nits.
2009-01-03 12:15:04 +01:00
sphinx-quickstart.py
Some more license nits.
2009-01-03 12:15:04 +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%