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
5,642 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%
e6ddd326d1
Go to file
Anthony Johnson e6ddd326d1 Tune sphinx_rtd_theme version 
With some recent changes that are slightly backwards compatible, we were going
to bump the version of the RTD theme. We wanted to drop the current version
pattern for the semver scheme, but Sphinx's requirement on the RTD theme is
pinned at >=0.1,<0.2. For now, we're stuck releasing on the current scheme.

This relaxes the versioning requirement for the theme, with 2.0 being the
following release that could contain backwards incompatible API changes. We'd
likely wait to bump to 1.0 until the next Sphinx release, as to not break
experience for users.

Refs snide/sphinx_rtd_theme#244
2015-09-09 11:38:03 -07:00
doc C++, add namespace push/pop directives. 2015-09-06 22:28:55 +02:00
sphinx C++, add namespace push/pop directives. 2015-09-06 22:28:55 +02:00
tests C++, fix for template argument parsing. 2015-09-06 20:34:01 +02:00
utils fix for make check 2015-03-10 00:22:02 +09:00
.gitignore add a .gitignore file, remove .hgignore 2015-01-02 12:25:23 +01:00
.travis.yml add flake8 check to travis 2015-03-07 17:59:31 +09:00
AUTHORS Update CHANGES and AUTHORS. Closes #1765. 2015-03-10 22:19:25 +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 C++, add namespace push/pop directives. 2015-09-06 22:28:55 +02: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 remove or update missing links. 2015-03-07 22:07:46 +09:00
ez_setup.py update bundled ez_setup.py for setuptools-7.0 that requires Python 2.6 or later. 2014-12-03 23:17:48 +09:00
LICENSE Merge branch 'stable' 2015-01-03 21:41:14 +01:00
Makefile fix trailing space and long line 2014-10-09 23:53:33 +09:00
MANIFEST.in remove custom_fixers from MANIFEST.in. that directory already removed at 47baff4 2014-08-25 16:35:38 +09:00
README.rst Support PEP-440 version spec for developers. 2015-03-14 16:46:24 +09:00
setup.cfg Support PEP-440 version spec for developers. 2015-03-14 16:46:24 +09:00
setup.py Tune sphinx_rtd_theme version 2015-09-09 11:38:03 -07:00
sphinx-apidoc.py all: update copyright 2015-01-03 21:36:32 +01:00
sphinx-autogen.py all: update copyright 2015-01-03 21:36:32 +01:00
sphinx-build.py all: update copyright 2015-01-03 21:36:32 +01:00
sphinx-quickstart.py all: update copyright 2015-01-03 21:36:32 +01:00
test-reqs.txt add flake8 testing 2015-03-07 17:59:28 +09:00
tox.ini add flake8 testing 2015-03-07 17:59:28 +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 .


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>.