sphinx

mirror of https://github.com/sphinx-doc/sphinx.git synced 2026-09-03 20:52:55 -05:00

T

Dmitry Shachnev ce2185ce27 Modernize the code now that Python 2.5 is no longer supported

- Use print function instead of print statement;
- Use new exception handling;
- Use in operator instead of has_key();
- Do not use tuple arguments in functions;
- Other miscellaneous improvements.

This is based on output of `futurize --stage1`, with some
manual corrections.

2014-01-19 14:17:10 +04:00

custom_fixers

Rename __unicode__ to __str__

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

doc

merge heads

2014-01-18 16:34:47 +09:00

sphinx

Modernize the code now that Python 2.5 is no longer supported

2014-01-19 14:17:10 +04:00

tests

Modernize the code now that Python 2.5 is no longer supported

2014-01-19 14:17:10 +04:00

utils

Modernize the code now that Python 2.5 is no longer supported

2014-01-19 14:17:10 +04: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

Added improvements about i18n for themes "basic", "haiku" and "scrolls" that Sphinx built-in. Closes #1120

2013-03-04 10:35:30 -05:30

CHANGES

changelog: bette note about literal_strong

2014-01-19 07:32:10 +01:00

CHANGES.old

changelog: split off older changes (pre-1.0) to a CHANGES.old file

2013-03-29 13:05:49 +01:00

EXAMPLES

docs: fix some broken links

2014-01-13 00:05:22 +01:00

ez_setup.py

Added a ez_setup to replace distribute_setup. ez_setup become defacto. Closes #1264

2013-10-03 05:55:58 +00: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 #1152 : Fix pycode parsing errors of Python 3 code by including two grammar

2014-01-12 19:44:04 +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

Drop python-3.1 and remove support codes

2013-12-15 16:04:23 +09: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

Drop python-3.1 and remove support codes

2013-12-15 16:04:23 +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.