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,407 Commits 2 Branches 219 Tags
91d92be8adae2e44e1e23e1c07b7088c35261abf
Go to file
Clone
Open with VS Code Open with VSCodium Open with Intellij IDEA
Download ZIP Download TAR.GZ Download BUNDLE
Georg Brandl 91d92be8ad Add "make mode" to sphinx-build, invoked by the -M flag. 
This is intended to do almost all of what the quickstart-generated Makefile
and make.bat did, but within Sphinx.  The advantages are:

* no duplication between Unix and Windows files
* updates and fixes are propagated (the generated makefiles never update)
* more Python code, less shell code!
2014-01-11 19:36:05 +01:00
custom_fixers
Rename __unicode__ to __str__
2010-05-09 14:57:18 +02:00
doc
Add "make mode" to sphinx-build, invoked by the -M flag.
2014-01-11 19:36:05 +01:00
sphinx
Add "make mode" to sphinx-build, invoked by the -M flag.
2014-01-11 19:36:05 +01:00
tests
* add a test for the parsed-literal directive
2014-01-11 10:25:34 +01:00
utils
checklist: add a reminder to remove build/ to run 2to3 correctly
2014-01-10 09:39:39 +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
Closes #929: Support parsed-literal blocks in LaTeX output correctly.
2014-01-11 10:19:52 +01: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 QGIS page for examples page
2013-10-03 06:08:24 +00: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
Add extension of included README (.rst)
2013-10-28 20:53:57 +11: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
Added a ez_setup to replace distribute_setup. ez_setup become defacto. Closes #1264
2013-10-03 05:55:58 +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
Add "make mode" to sphinx-build, invoked by the -M flag.
2014-01-11 19:36:05 +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%