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
4,217 Commits 2 Branches 219 Tags
8faf3156436f4c1172fb976a7def554efca8e037
Go to file
Clone
Open with VS Code Open with VSCodium Open with Intellij IDEA
Download ZIP Download TAR.GZ Download BUNDLE
Kevin Burke 8faf315643 Add more inline examples 
The idea is to show off all of the supported functionality of Sphinx
autodocs for domains in the given example. I always get confused about
the format for raised exceptions, etc. It would be great if this was a
little bit more of a comprehensive reference.
2013-09-05 09:52:54 -07:00
custom_fixers
Rename __unicode__ to __str__
2010-05-09 14:57:18 +02:00
doc
Add more inline examples
2013-09-05 09:52:54 -07:00
sphinx
Unify usage of os.path/path in EpubBuilder.
2013-08-10 15:10:20 +02:00
tests
support parallel testing with detox
2013-07-27 16:15:36 +09:00
utils
Copyright header update.
2013-04-01 11:41:48 +02: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
Sphinx generates broken ePub on Windows. Closes #1232
2013-08-10 18:25:28 +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
distribute_setup.py
Update distribute_setup.py to version 0.6.30 (http://python-distribute.org/distribute_setup.py)
2012-11-03 07:35:20 -05:00
EXAMPLES
Add some URLs to example list.
2013-07-27 00:40:08 +09: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 #809: Include custom fixers in the source distribution.
2011-11-01 21:40:52 +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 Python version compatibility with Jinja2 2.7. closes #1173
2013-05-29 09:16:14 +00:00
sphinx-apidoc.py
Copyright update.
2013-01-01 22:13:15 +01:00
sphinx-autogen.py
Copyright update.
2013-01-01 22:13:15 +01:00
sphinx-build.py
Copyright update.
2013-01-01 22:13:15 +01:00
sphinx-quickstart.py
Copyright update.
2013-01-01 22:13:15 +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.
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%