mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
68021b0bd3
- Rename 'default' theme to 'classic'. - rename `themes/default` to `themes/classic` - add new `themes/default` theme that derives from 'classic' theme for compatibility. - setup.py depends to 'alabaster' and 'rtd' theme. - theming.py import and run `alabaster.get_path()` to append path for alabaster theme. - theming.py also import and run `sphinx_rtd_theme.get_html_theme_path()` to append path. - sphinx-quickstart will generate `html_theme = 'alabaster'`. - If user use 'default', sphinx emit notice (WARNING) suggestion to use 'alabaster' or use 'classic'. - add documentation for new alabaster and readthedoc theme and link to original pages: - https://pypi.python.org/pypi/alabaster - https://pypi.python.org/pypi/sphinx_rtd_theme
=================
README for Sphinx
=================
This is the Sphinx documentation generator, see http://sphinx-doc.org/.
Installing
==========
Use ``setup.py``::
python setup.py build
sudo python setup.py install
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.
#. 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>.