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
6,904 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%
1951d559d9
Go to file
mulhern 1951d559d9 Make sure extensions specified with -D override extensions in config file. 
Previously, a comma separated list of extensions was read and parsed
correctly. However, the value was then stored in config hashtable,
which was overwritten when the config file was parsed.

Now, the config file is parsed first, and the the entry in the config
hashtable is updated with the overriding extension, if it exists.

Signed-off-by: mulhern <amulhern@redhat.com>
2016-07-28 07:48:10 -04:00
doc Turn off viewcode extension by default 2016-07-28 15:38:38 +09:00
sphinx Make sure extensions specified with -D override extensions in config file. 2016-07-28 07:48:10 -04:00
tests Merge branch 'stable' 2016-07-26 14:26:11 +09:00
utils Handle more file closing with "with" 2016-07-07 18:53:34 +03:00
.gitignore Add .swp to .gitignore 2016-01-02 22:42:16 +09:00
.travis.yml Merge branch 'stable' 2016-07-26 14:26:11 +09:00
AUTHORS Create PyGroupedField and use it for 'exceptions' 2016-07-15 22:01:06 -04: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 document warning 2016-07-28 15:38:38 +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 Merge branch 'stable' into 1.4-release 2016-03-23 22:01:14 +09:00
LICENSE Obligatory copyright update. 2016-01-14 22:54:04 +01:00
Makefile Remove env from DONT_CHECK (ref: #2760) 2016-07-16 00:47:19 +09:00
MANIFEST.in Fix common template files are not distributed 2016-07-15 22:36:05 +09:00
README.rst Add a release signature to README (ref: #2612) 2016-07-02 16:37:00 +09:00
setup.cfg Skip flake8 for sample python codes for napoleon docs 2016-07-26 14:35:20 +09:00
setup.py Handle more file closing with "with" 2016-07-07 18:53:34 +03:00
sphinx-apidoc.py Obligatory copyright update. 2016-01-14 22:54:04 +01:00
sphinx-autogen.py Obligatory copyright update. 2016-01-14 22:54:04 +01:00
sphinx-build.py Obligatory copyright update. 2016-01-14 22:54:04 +01:00
sphinx-quickstart.py Obligatory copyright update. 2016-01-14 22:54:04 +01:00
test-reqs.txt Merge branch 'stable' 2016-07-15 00:51:29 +09:00
tox.ini Add html5lib to tox.ini 2016-06-12 00:43:23 +09:00

README.rst 

=================
README for Sphinx
=================

This is the Sphinx documentation generator, see http://sphinx-doc.org/.


Installing
==========

Install from PyPI to use stable version::

   pip install -U sphinx

Install from PyPI to use beta version::

   pip install -U --pre sphinx

Install from newest dev version in stable branch::

   pip install git+https://github.com/sphinx-doc/sphinx@stable

Install from newest dev version in master branch::

   pip install git+https://github.com/sphinx-doc/sphinx

Install from cloned source::

   pip install .

Install from cloned source as editable::

   pip install -e .


Release signatures
==================

Releases are signed with `498D6B9E <https://pgp.mit.edu/pks/lookup?op=vindex&search=0x102C2C17498D6B9E>`_


Reading the docs
================

After installing::

   cd doc
   make 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

Continuous testing runs on travis:

.. image:: https://travis-ci.org/sphinx-doc/sphinx.svg?branch=master
   :target: https://travis-ci.org/sphinx-doc/sphinx


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

#. Check for open issues or open a fresh issue to start a discussion around a
   feature idea or a bug.
#. If you feel uncomfortable or uncertain about an issue or your changes, feel
   free to email sphinx-dev@googlegroups.com.
#. Fork the repository on GitHub https://github.com/sphinx-doc/sphinx
   to start making your changes to the **master** branch for next major
   version, or **stable** branch for next minor version.
#. Write a test which shows that the bug was fixed or that the feature works
   as expected.  Use ``make test`` to run the test suite.
#. Send a pull request and bug the maintainer until it gets merged and
   published.  Make sure to add yourself to AUTHORS
   <https://github.com/sphinx-doc/sphinx/blob/master/AUTHORS> and the change to
   CHANGES <https://github.com/sphinx-doc/sphinx/blob/master/CHANGES>.