mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
9752525ed1
For PDF via LaTeX PR #2304 (ac7d7b5) implemented wrapping of long code lines in literal blocks and PR #3340 (8c21abe) extended this to parsed literals. On this occasion the space was defined as a LaTeX macro, depending on the used font, and as it allowed some potential uses it was allowed for the space to obey the stretch and shrink as configured in the used font. The default is to render using the mono font (``\ttfamily``), hence a priori the stretchability and shrinkability are anyhow zero. Non-zero stretch/shrink was left as a theoretical possibility for special purposes; but although it may make sense to use a "variable mono" for non-Python code, it is certainly not adequate for things like verbatim grid tables... The problem is that XeTeX does not set the TeX font parameters to zero for OpenType fonts of Mono type, as is discussed there: http://tug.org/pipermail/xetex/2017-January/026956.html and in particular applies to the Latin Modern OpenType font, which is the default when loading fontspec package. Due to this problem there was a LaTeX kernel patch update late January 2017 to forcefully set the corresponding TeX font parameters to zero (indeed since 2017/01/01 release LaTeX uses OpenType fonts by default under XeTeX/LuaTeX engines.) But this is only a specific kludge for handling the Latin Modern Mono font. Other OpenType fonts of MonoSpace type may still show the XeTeX issue. To make things simple, this commit simply avoids ascribing to the space the font stretch or shrink as set in the TeX font parameters. This will alleviate problems with Monospace fonts with XeTeX and avoir user reports that their literal-blocks are all wrong. Existing documents are not affected. The possibility to use a variable space mono font had not been documented.
.. image:: https://img.shields.io/pypi/v/sphinx.svg
:target: http://pypi.python.org/pypi/sphinx
.. image:: https://readthedocs.org/projects/sphinx/badge/
:target: http://www.sphinx-doc.org/
:alt: Documentation Status
.. image:: https://travis-ci.org/sphinx-doc/sphinx.svg?branch=master
:target: https://travis-ci.org/sphinx-doc/sphinx
=================
README for Sphinx
=================
This is the Sphinx documentation generator, see http://www.sphinx-doc.org/.
Installing
==========
Install from PyPI to use stable version::
pip install -U sphinx
Install from PyPI to use beta version::
pip install -U --pre sphinx
Install from newest dev version in stable branch::
pip install git+https://github.com/sphinx-doc/sphinx@stable
Install from newest dev version in master branch::
pip install git+https://github.com/sphinx-doc/sphinx
Install from cloned source::
pip install .
Install from cloned source as editable::
pip install -e .
Release signatures
==================
Releases are signed with following keys:
* `498D6B9E <https://pgp.mit.edu/pks/lookup?op=vindex&search=0x102C2C17498D6B9E>`_
* `5EBA0E07 <https://pgp.mit.edu/pks/lookup?op=vindex&search=0x1425F8CE5EBA0E07>`_
Reading the docs
================
You can read them online at <http://www.sphinx-doc.org/>.
Or, after installing::
cd doc
make html
Then, direct your browser to ``_build/html/index.html``.
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
Continuous testing runs on travis: https://travis-ci.org/sphinx-doc/sphinx
Contributing
============
See `CONTRIBUTING.rst`__
.. __: CONTRIBUTING.rst