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,529 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%
edb8fd96bd
Go to file
Takayuki Shimizukawa edb8fd96bd Fix: make-mode will work with sphinx-build command that is generated from setup.py entry_points definition. 
This fix relates to https://bitbucket.org/birkenfeld/sphinx/pull-request/203/add-make-mode-to-sphinx-build-invoked-by/diff#comment-1133945
2014-05-25 02:06:39 +09:00
custom_fixers Rename __unicode__ to __str__ 2010-05-09 14:57:18 +02:00
doc Add an example how to connect events. 2014-03-26 07:30:48 +01:00
sphinx Fix: make-mode will work with sphinx-build command that is generated from setup.py entry_points definition. 2014-05-25 02:06:39 +09:00
tests refactoring the test_autosummary.py 2014-04-12 00:24:53 +09:00
utils Fix long lines. 2014-03-02 08:40:48 +01: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 Fix: In python3 environment, make linkcheck cause "Can't convert 'bytes' 2014-05-04 00:43:50 +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 more projects to examples. 2014-03-05 07:52:55 +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 Copyright update. 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 Fix: Generated i18n sphinx.js files are missing message catalog entries from '.js_t' and '.html'. The issue was introduced from Sphinx-1.1. Closes #1419 2014-03-21 10:58:41 +09:00
sphinx-apidoc.py Update copyright year. 2014-03-01 08:18:16 +01:00
sphinx-autogen.py Update copyright year. 2014-03-01 08:18:16 +01:00
sphinx-build.py Fix: make-mode will work with sphinx-build command that is generated from setup.py entry_points definition. 2014-05-25 02:06:39 +09:00
sphinx-quickstart.py Update copyright year. 2014-03-01 08:18:16 +01:00
TODO Dummy change. 2009-10-26 09:30:43 +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


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

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