The Sphinx documentation generator
Go to file
Michael Jones 71660ccdf1 Account for arguments with only a type and no parameter name
Previously, the code was parsing the type into the argname variable and then
when it found something (not "," or ")") following the type it swapped the name
into the type and parsed next part as the name.

However, when no name is provided, as it allowed in c++, if you're not planning
on using the parameter, or it is in a function declaration, then the actual
type was being left in the name variable and the type variable was empty.

As a result function signatures for references were being generated without
knowledge of the type, which is the important factor in disambiguating
overloaded functions.
2010-11-18 08:56:39 +13:00
doc #550: fix confusing example in docs. 2010-11-12 08:26:20 +01:00
sphinx Account for arguments with only a type and no parameter name 2010-11-18 08:56:39 +13:00
tests Adapt test to new warning API. 2010-11-12 08:34:47 +01:00
utils Remove obsolete todo entry. 2010-01-18 00:38:10 +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 Update release date and version. 2010-11-12 08:35:03 +01:00
EXAMPLES Add pypol. 2010-10-17 08:41:52 +02: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 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 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
tox.ini Add docutils 0.7 target. 2010-07-26 19:31:07 +02:00

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