IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity
The Sphinx documentation generator
4,604 Commits 2 Branches 219 Tags 163 MiB
Python 79.5%
JavaScript 11.5%
TeX 5.6%
Jinja 2.5%
HTML 0.6%
Other 0.2%
14b4a56bec
Go to file
Georg Brandl 14b4a56bec Closes #1680: fix botched error check for nonexisting environment file
2015-01-17 11:23:55 +01:00
custom_fixers Rename __unicode__ to __str__ 2010-05-09 14:57:18 +02:00
doc all: update copyright 2015-01-03 21:36:32 +01:00
sphinx Closes #1680: fix botched error check for nonexisting environment file 2015-01-17 11:23:55 +01:00
tests all: update copyright 2015-01-03 21:36:32 +01:00
utils all: update copyright 2015-01-03 21:36:32 +01:00
.gitignore add a .gitignore file, remove .hgignore 2015-01-02 12:25:23 +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 Fixes #1686: ifconfig directive doesn't care about default config values. 2015-01-17 16:01:53 +09: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 add a example 2014-12-30 18:00:53 +09: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 license: fix copyright year 2015-01-03 21:41:31 +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 readme: update drone->travis 2015-01-02 13:54:04 +01:00
setup.cfg Add setup.py "upload" alias for automatic package signing. 2013-02-05 09:19:52 +01:00
setup.py Exclude 'tests' instead of 'test'. Sphinx-1.2.3 wheel package includes 'tests' directory. It might be happen by this wrong parameter. 2015-01-06 22:23:05 +09:00
sphinx-apidoc.py all: update copyright 2015-01-03 21:36:32 +01:00
sphinx-autogen.py all: update copyright 2015-01-03 21:36:32 +01:00
sphinx-build.py all: update copyright 2015-01-03 21:36:32 +01:00
sphinx-quickstart.py all: update copyright 2015-01-03 21:36:32 +01:00
tox.ini support parallel testing with detox 2013-07-27 16:15:36 +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

Continuous testing runs on travis:

.. image:: https://travis-ci.org/sphinx-doc/sphinx.svg?branch=master
   :target: https://travis-ci.org/sphinx-doc/sphinx


Contributing
============

Send wishes, comments, patches, etc. to sphinx-dev@googlegroups.com.