sphinx

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

Go to file

Jonathan Waltman db9cfa4d1a Speed up search index generation by caching word stemming calls.

Saves about 20 seconds when building the Python documentation.

Here are some stats for building the Python docs on my machine with
and without stem caching.

Without stem caching::

    % rm -fr _build
    % \time sphinx-build -q . _build/html
    158.22user 0.87system 2:39.25elapsed 99%CPU (0avgtext+0avgdata 400800maxresident)k
    104inputs+180240outputs (1major+113472minor)pagefaults 0swaps

    % \time sphinx-build -a -q . _build/html
    91.00user 0.67system 1:31.73elapsed 99%CPU (0avgtext+0avgdata 330704maxresident)k
    0inputs+69864outputs (1major+106009minor)pagefaults 0swaps

With stem caching::

    % rm -fr _build
    % \time sphinx-build -q . _build/html
    137.90user 1.10system 2:20.50elapsed 98%CPU (0avgtext+0avgdata 413344maxresident)k
    18896inputs+180232outputs (1major+113779minor)pagefaults 0swaps

    % \time sphinx-build -a -q . _build/html
    70.04user 0.74system 1:10.87elapsed 99%CPU (0avgtext+0avgdata 345632maxresident)k
    16inputs+69864outputs (1major+108010minor)pagefaults 0swaps

2013-02-18 21:02:51 -06:00

custom_fixers

Rename __unicode__ to __str__

2010-05-09 14:57:18 +02:00

doc

doc/_templates/index.html: fix link to the list of extensions

2013-02-10 16:39:44 +04:00

sphinx

Speed up search index generation by caching word stemming calls.

2013-02-18 21:02:51 -06:00

tests

conf.py now accept CRLF end-of-line.

2013-02-10 15:25:45 +09:00

utils

2013-01-01 22:13:15 +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

Add Hernan.

2013-01-03 10:11:18 +01:00

babel.cfg

Update POT file for new template locations.

2009-05-22 18:19:30 +02:00

CHANGES

Speed up search index generation by caching word stemming calls.

2013-02-18 21:02:51 -06:00

distribute_setup.py

Update distribute_setup.py to version 0.6.30 (http://python-distribute.org/distribute_setup.py )

2012-11-03 07:35:20 -05:00

EXAMPLES

Add the Ubuntu packaging guide.

2012-11-04 11:29:47 +01:00

LICENSE

2013-01-01 22:13:15 +01: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 #809 : Include custom fixers in the source distribution.

2011-11-01 21:40:52 +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

Avoid unknown option warnings for use_2to3 in setup.py under Python 2.

2012-11-11 01:33:52 -06:00

sphinx-apidoc.py

2013-01-01 22:13:15 +01:00

sphinx-autogen.py

2013-01-01 22:13:15 +01:00

sphinx-build.py

2013-01-01 22:13:15 +01:00

sphinx-quickstart.py

2013-01-01 22:13:15 +01:00

TODO

Dummy change.

2009-10-26 09:30:43 +01:00

tox.ini

remove comment-outed docutils repository for py33 test

2013-01-01 15:29:43 +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%