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
2,504 Commits 2 Branches 219 Tags
86215260458069fdc9b64b58e111540e03f4ff6a
Go to file
Clone
Open with VS Code Open with VSCodium Open with Intellij IDEA
Download ZIP Download TAR.GZ Download BUNDLE
Georg Brandl 8621526045 #568: Fix lookup of class attribute documentation on descriptors so that comment documentation now works. 
Needed to port assignment of ``self.parent`` from trunk.
2011-01-06 13:03:17 +01:00
doc
Update github pages advice.
2011-01-05 18:12:51 +01:00
sphinx
#568: Fix lookup of class attribute documentation on descriptors so that comment documentation now works.
2011-01-06 13:03:17 +01:00
tests
#568: Fix lookup of class attribute documentation on descriptors so that comment documentation now works.
2011-01-06 13:03:17 +01:00
utils
New year update.
2011-01-04 10:00:51 +01:00
.hgignore
Fix :guilabel: unescaping, and make some tests actually run.
2010-07-21 11:33:24 +01:00
AUTHORS
In the default theme, the sidebar can experimentally now be made collapsible using the new `collapsiblesidebar` theme option.
2010-05-24 23:14:35 +02:00
babel.cfg
Update POT file for new template locations.
2009-05-22 18:19:30 +02:00
CHANGES
#568: Fix lookup of class attribute documentation on descriptors so that comment documentation now works.
2011-01-06 13:03:17 +01:00
EXAMPLES
Add Leo.
2011-01-06 12:08:26 +01:00
ez_setup.py
Update ez_setup.py.
2008-11-23 19:50:56 +01:00
LICENSE
New year update.
2011-01-04 10:00:51 +01:00
Makefile
Make make check happy.
2010-07-23 12:38:41 +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
Teach babel to extract l_() messages.
2009-07-03 13:37:38 +02:00
setup.py
Update for 1.0.
2010-07-23 12:42:03 +01:00
sphinx-autogen.py
New year update.
2011-01-04 10:00:51 +01:00
sphinx-build.py
New year update.
2011-01-04 10:00:51 +01:00
sphinx-quickstart.py
New year update.
2011-01-04 10:00:51 +01:00
TODO
Dummy change.
2009-10-26 09:30:43 +01:00
tox.ini
Add docutils 0.7 target.
2010-07-26 19:31:07 +02: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.
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%