mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
The Sphinx documentation generator
773ba3b768
This commit fixes part of 5976facae92c commit:
Refactor comment generating code for message catalogs.
The commit says "Refactor" but it changes original code behavior.
In original code, source locations are separated with " " but
in refactored code, source locations are separated with ", ".
msgmerge and po-mode that are part of the GNU gettext toolset treats
"," as part of source location. We can fix this problem by one of them:
* Use " " instead of ", " as source locations separator
in a "reference" line.
* Put "reference" lines. Each "reference" line just has a source location.
This commit uses the latter because the latter has more higher readablility.
See also about "reference" line but it doesn't say about separator:
http://www.gnu.org/s/hello/manual/gettext/PO-Files.html
|
||
|---|---|---|
| custom_fixers | ||
| doc | ||
| sphinx | ||
| tests | ||
| utils | ||
| .hgignore | ||
| AUTHORS | ||
| babel.cfg | ||
| CHANGES | ||
| distribute_setup.py | ||
| EXAMPLES | ||
| LICENSE | ||
| Makefile | ||
| MANIFEST.in | ||
| README | ||
| setup.cfg | ||
| setup.py | ||
| sphinx-apidoc.py | ||
| sphinx-autogen.py | ||
| sphinx-build.py | ||
| sphinx-quickstart.py | ||
| TODO | ||
| tox.ini | ||
.. -*- restructuredtext -*-
=================
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.pocoo.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.