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
3,524 Commits 2 Branches 219 Tags
1d188e778f7add99871ec7e164c0f915493a7544
Go to file
Clone
Open with VS Code Open with VSCodium Open with Intellij IDEA
Download ZIP Download TAR.GZ Download BUNDLE
Fraser Tweedale 1d188e778f apidoc: read options from SPHINX_APIDOC_OPTIONS envvar if set 
If the SPHINX_APIDOC_OPTIONS environment variable exists, read
OPTIONS from there, otherwise use the existing default options.
This allows some configurability of sphinx-apidoc.
2011-12-21 15:22:46 +10:00
custom_fixers
Rename __unicode__ to __str__
2010-05-09 14:57:18 +02:00
doc
Closes #793: Fix docutils version references.
2011-11-01 09:16:37 +01:00
sphinx
apidoc: read options from SPHINX_APIDOC_OPTIONS envvar if set
2011-12-21 15:22:46 +10:00
tests
Satisfy "make check".
2011-10-09 23:09:57 +02:00
utils
merge with 1.0
2011-01-04 11:29:09 +01:00
.hgignore
Ignore files generated when building the test docs
2010-11-02 13:15:18 +01:00
AUTHORS
Add attribution for 9b4e41bba142.
2011-09-17 20:53:44 +02:00
babel.cfg
Update POT file for new template locations.
2009-05-22 18:19:30 +02:00
CHANGES
Closes #809: Include custom fixers in the source distribution.
2011-11-01 21:40:52 +01:00
distribute_setup.py
update distribute_setup.py from http://python-distribute.org/distribute_setup.py
2010-06-15 23:16:33 +02:00
EXAMPLES
Merge with 1.0
2011-09-23 22:03:34 +02:00
LICENSE
Closes #724: Add license for Underscore.js.
2011-06-28 20:37:29 +02: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 #809: Include custom fixers in the source distribution.
2011-11-01 21:40:52 +01:00
README
Add some changes not picked up in the transplantation process.
2010-07-28 19:49:06 +02:00
setup.cfg
Teach babel to extract l_() messages.
2009-07-03 13:37:38 +02:00
setup.py
Pre-release updates.
2011-10-09 23:25:40 +02:00
sphinx-apidoc.py
#98: Add autopackage script. (Undocumented for now.)
2011-01-04 19:20:22 +01:00
sphinx-autogen.py
New year update.
2011-01-04 10:00:51 +01:00
sphinx-build.py
New year update.
2011-01-04 10:00:51 +01:00
sphinx-quickstart.py
New year update.
2011-01-04 10:00:51 +01:00
TODO
Dummy change.
2009-10-26 09:30:43 +01:00
tox.ini
Update tox.ini with py32/du08 envs.
2011-09-23 07:59:19 +02:00

README 

.. -*- 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.
Description
The Sphinx documentation generator
docsdocumentationdocumentation-toolmarkdownpythonrestructuredtextsphinx
Readme 125 MiB
Languages
Python 79.5%
JavaScript 11.5%
TeX 5.6%
Jinja 2.5%
HTML 0.6%
Other 0.2%