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
The Sphinx documentation generator
1,470 Commits 2 Branches 219 Tags 163 MiB
Python 79.5%
JavaScript 11.5%
TeX 5.6%
Jinja 2.5%
HTML 0.6%
Other 0.2%
9d15d3f654
Go to file
Georg Brandl 9d15d3f654 #302: Fix links generated by the `:doc:` role for LaTeX output. 
For that, record the source docname in an xfileref node in node['refdoc'].
The LaTeX builder creates one big toctree out of all documents, therefore
"fromdocname" in resolve_references refers to the wrong file.
2010-01-03 16:03:08 +01:00
doc #162: add link to sphinx.pocoo.org/latest. 2010-01-03 15:36:51 +01:00
sphinx #302: Fix links generated by the `:doc:` role for LaTeX output. 2010-01-03 16:03:08 +01:00
tests Add tests for todo extension. 2010-01-03 12:39:55 +01:00
utils Update check_sources; we now have 201x. 2010-01-02 21:11:23 +01:00
.hgignore #146: Don't fail to generate LaTeX when the user has an active 2009-05-03 10:32:32 +02:00
AUTHORS Remove extra autosummary license since Sphinx now uses 2-clause BSD as well. 2009-03-14 21:16:20 +01:00
babel.cfg Update POT file for new template locations. 2009-05-22 18:19:30 +02:00
CHANGES #302: Fix links generated by the `:doc:` role for LaTeX output. 2010-01-03 16:03:08 +01:00
EXAMPLES Add Bazaar. 2010-01-02 14:24:26 +01:00
ez_setup.py Update ez_setup.py. 2008-11-23 19:50:56 +01:00
LICENSE Happy new year! 2010-01-01 14:09:13 +01:00
Makefile Update check_sources; we now have 201x. 2010-01-02 21:11:23 +01:00
MANIFEST.in Fix manifest. Again. 2009-03-28 14:51:45 -05:00
README Mark up. 2009-03-09 09:42:05 +01:00
setup.cfg Add i18n support, thanks to Horst Gutmann. 2008-08-08 10:54:00 +00:00
setup.py Provide a ==dev egg link in pkg-info. 2009-05-17 12:39:43 +02:00
sphinx-autogen.py Happy new year! 2010-01-01 14:09:13 +01:00
sphinx-build.py Happy new year! 2010-01-01 14:09:13 +01:00
sphinx-quickstart.py Happy new year! 2010-01-01 14:09:13 +01:00
TODO Dummy change. 2009-10-26 09:30:43 +01:00

README 

.. -*- restructuredtext -*-

=================
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.