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
2,065 Commits 2 Branches 219 Tags
ae0d464fb1c06debc119c693f6ab58fb3e4c45d6
Go to file
Clone
Open with VS Code Open with VSCodium Open with Intellij IDEA
Download ZIP Download TAR.GZ Download BUNDLE
Daniel Neuhäuser ae0d464fb1 Added doc_field_types to :class:JSCallable, arguments, errors and the return value of JavaScript functions/methods/constructors can now be documented using fields.
2010-03-31 15:15:43 +00:00
doc
Added doc_field_types to :class:JSCallable, arguments, errors and the return value of JavaScript functions/methods/constructors can now be documented using fields.
2010-03-31 15:15:43 +00:00
sphinx
Added doc_field_types to :class:JSCallable, arguments, errors and the return value of JavaScript functions/methods/constructors can now be documented using fields.
2010-03-31 15:15:43 +00:00
tests
Added doc_field_types to :class:JSCallable, arguments, errors and the return value of JavaScript functions/methods/constructors can now be documented using fields.
2010-03-31 15:15:43 +00:00
utils
Remove obsolete todo entry.
2010-01-18 00:38:10 +01:00
.hgignore
Ignore emacs dir-locals.
2009-09-08 14:53:31 +02:00
AUTHORS
Add theme authors.
2010-01-07 11:49:48 +01:00
babel.cfg
Update POT file for new template locations.
2009-05-22 18:19:30 +02:00
CHANGES
merge with trunk
2010-03-16 08:54:03 +01:00
EXAMPLES
Add Blinker.
2010-02-28 09:19:00 +01:00
ez_setup.py
Update ez_setup.py.
2008-11-23 19:50:56 +01:00
LICENSE
Happy new year!
2010-01-01 14:09:13 +01:00
Makefile
merge with trunk
2010-01-07 19:07:50 +01:00
MANIFEST.in
Fix manifest. Again.
2009-03-28 14:51:45 -05:00
README
Mark up.
2009-03-09 09:42:05 +01:00
setup.cfg
Teach babel to extract l_() messages.
2009-07-03 13:37:38 +02:00
setup.py
Update blurb in setup.py and on the index page, link directly to tutorial.rst from index.
2010-02-28 23:12:00 +01:00
sphinx-autogen.py
Happy new year!
2010-01-01 14:09:13 +01:00
sphinx-build.py
Happy new year!
2010-01-01 14:09:13 +01:00
sphinx-quickstart.py
Happy new year!
2010-01-01 14:09:13 +01:00
TODO
Dummy change.
2009-10-26 09:30:43 +01: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/>.


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%