mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
3a388148d7
The LaTeX reference target used to be the bibitem id. But the bibitem id was already rewritten to contain a number instead of the lowercased id name, that is given by the bibtex file. This change adds a new element to the bibitem instantiation which contains the id from the bibtex file. The hypertarget uses this bibitem element now. The alternative fix would be to hyperref the numbered id and leave the target with the id number as it is. We decided against it, because in the html builder both the ref and the target use the bibtex id name and not the number. Signed-off-by: Erik Bernoth <erik.bernoth@gmail.com> Acked-by: Matthias C. M. Troffaes <matthias.troffaes@gmail.com>
=================
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.