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
663 Commits 2 Branches 219 Tags
efd474b296e13e8a7c4a15baf859fa8c59316094
Go to file
Clone
Open with VS Code Open with VSCodium Open with Intellij IDEA
Download ZIP Download TAR.GZ Download BUNDLE
Georg Brandl efd474b296 Add a caveat about LaTeX titles and authors, and properly escape 
a title that comes from the document itself.
2008-10-16 19:37:57 +00:00
doc
Add a caveat about LaTeX titles and authors, and properly escape
2008-10-16 19:37:57 +00:00
sphinx
Add a caveat about LaTeX titles and authors, and properly escape
2008-10-16 19:37:57 +00:00
tests
Adapt markup test to renaming of highlighting escapes.
2008-09-16 07:52:19 +00:00
utils
Merged revisions 64808,65013,65076,65100-65101,65119,65121-65123 via svnmerge from
2008-07-18 22:55:36 +00: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
Add "source_encoding" config value.
2008-10-16 19:21:06 +00:00
EXAMPLES
Add new projects/URLs.
2008-10-08 11:24:37 +00:00
ez_setup.py
Merged revisions 65283,65303,65316-65317,65372-65375,65377,65380,65483-65485,65494 via svnmerge from
2008-08-04 17:01:15 +00:00
LICENSE
Add authors and license files.
2008-01-11 14:19:54 +00:00
Makefile
Merged revisions 65566-65567,65623,65625 via svnmerge from
2008-08-10 16:59:27 +00:00
README
Add mkdir step to README.
2008-03-28 07:34:26 +00:00
setup.cfg
Add i18n support, thanks to Horst Gutmann.
2008-08-08 10:54:00 +00:00
setup.py
cmdclass must stay.
2008-09-09 21:23:57 +00:00
sphinx-build.py
Add shebangs.
2008-06-23 12:38:21 +00:00
sphinx-quickstart.py
Add shebangs.
2008-06-23 12:38:21 +00:00
TODO
Track TODO items on code.google.com tracker.
2008-09-12 16:29:52 +00: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
   mkdir -p _build/html
   sphinx-build . _build/html
   browser _build/index.html

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


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

Send wishes, comments, patches, etc. to georg@python.org.
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%