mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
cfc2245c8d
Modify the search tool to create single result set (instead of the current 4: regular, important, unimportantResults, objectResults). Each result has an associated score. The results are sorted by score before presenting the results. This modification does not seem to change the search time significantly. Patch by Hernan E. Grecco.
=================
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.