sphinx

mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00

Go to file

Guillem Barba fe077ea18b Don't multiply docnames list size per each listener of env-read-docs

The env-read-docs listener function doesn't return the modified docnames list
but change the list received as parameter.
Updated the tests

2014-09-21 19:50:46 +02:00

doc

Add env-read-docs event to allow modify docnames list before processing

2014-07-31 18:28:47 +02:00

sphinx

Don't multiply docnames list size per each listener of env-read-docs

2014-09-21 19:50:46 +02:00

tests

Don't multiply docnames list size per each listener of env-read-docs

2014-09-21 19:50:46 +02:00

utils

use b prefix for bytes instead of sphinx.pycompat.b function.

2014-05-01 22:54:09 +09: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

Using same word before.

2014-07-26 07:19:40 +02: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

Link-checked and updated the URLs for projects using Sphinx that are still available online.

2014-06-19 12:12:27 -04: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 #1418 : Private and special members are properly skipped on Python 3.3

2014-03-11 03:50:49 -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

raise six requirement to 1.4+ when UserString was added

2014-07-28 09:04:32 +00: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

Fix: make-mode will work with sphinx-build command that is generated from setup.py entry_points definition.

2014-05-25 02:06:39 +09: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

* Drop Python-3.2. And now, removing 2to3 mechanism procedure has been completed. Closes #1350 .

2014-05-27 23:17:36 +09: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.

Languages

Python 79.5%

JavaScript 11.5%

TeX 5.6%

Jinja 2.5%

HTML 0.6%

Other 0.2%