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
4,655 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%
191e0b4c12
Go to file
Rob Ruana 191e0b4c12 Closes #1384: Parse and interpret See Also section the way NumpyDoc does 
The NumpyDoc extension that is developed by the Numpy folks does a lot
of extra work interpreting See Also sections. It assumes that the contents
of the See Also will always be references to other functions/classes and
it tries to deduce what is being referenced.

I've ported their implementation for See Also sections written in the
Numpy style. There is NO extra interpretation done for See Also sections
that are written using the Google style.
2014-03-09 22:07:21 -04:00
custom_fixers Rename __unicode__ to __str__ 2010-05-09 14:57:18 +02:00
doc Closes #1396: Param types with inline markup no longer italicized 2014-03-09 01:56:56 -05:00
sphinx Closes #1384: Parse and interpret See Also section the way NumpyDoc does 2014-03-09 22:07:21 -04:00
tests Closes #1384: Parse and interpret See Also section the way NumpyDoc does 2014-03-09 22:07:21 -04:00
utils merge with stable 2014-03-02 08:50:10 +01:00
.hgignore Ignore files generated when building the test docs 2010-11-02 13:15:18 +01:00
.travis.yml Configure Travis CI. 2012-11-03 10:50:50 +01:00
AUTHORS Merges napoleon extension into mainline sphinx 2014-01-18 13:56:23 -05:00
babel.cfg Added improvements about i18n for themes "basic", "haiku" and "scrolls" that Sphinx built-in. Closes #1120 2013-03-04 10:35:30 -05:30
CHANGES Merged in shibu/sphinx/add_stemmer (pull request #214) 2014-03-04 19:10:19 +01:00
CHANGES.old changelog: split off older changes (pre-1.0) to a CHANGES.old file 2013-03-29 13:05:49 +01:00
EXAMPLES merge with stable 2014-03-06 08:13:14 +01:00
ez_setup.py Added a ez_setup to replace distribute_setup. ez_setup become defacto. Closes #1264 2013-10-03 05:55:58 +00:00
LICENSE Closes #1384: Parse and interpret See Also section the way NumpyDoc does 2014-03-09 22:07:21 -04:00
Makefile Ignore japanese search: it has long lines but breaking them would be ugly. 2011-01-15 16:01:14 +01:00
MANIFEST.in Closes #1152: Fix pycode parsing errors of Python 3 code by including two grammar 2014-01-12 19:44:04 +01:00
README.rst Update Sphinx URL to new sphinx-doc.org domain. 2012-11-04 11:28:12 +01:00
setup.cfg Add setup.py "upload" alias for automatic package signing. 2013-02-05 09:19:52 +01:00
setup.py Merged in shibu/sphinx/add_stemmer (pull request #214) 2014-03-04 19:10:19 +01:00
sphinx-apidoc.py Update copyright year. 2014-03-01 08:18:16 +01:00
sphinx-autogen.py Update copyright year. 2014-03-01 08:18:16 +01:00
sphinx-build.py Update copyright year. 2014-03-01 08:18:16 +01:00
sphinx-quickstart.py Update copyright year. 2014-03-01 08:18:16 +01:00
TODO Dummy change. 2009-10-26 09:30:43 +01:00
tox.ini du10/du11 need mock dependency 2014-03-08 11:27:12 +01:00

README.rst 

=================
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-doc.org/>.


Testing
=======

To run the tests with the interpreter available as ``python``, use::

    make test

If you want to use a different interpreter, e.g. ``python3``, use::

    PYTHON=python3 make test


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

Send wishes, comments, patches, etc. to sphinx-dev@googlegroups.com.