mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Reducing README.rst to avoid duplicated information in CONTRIBUTING.rst.
This commit is contained in:
parent
79fa283687
commit
3efd2df99b
@ -7,6 +7,9 @@ Sphinx Developer's Guide
|
||||
system used by developers to document systems used by other developers to
|
||||
develop other systems that may also be documented using Sphinx.
|
||||
|
||||
.. contents::
|
||||
:local:
|
||||
|
||||
The Sphinx source code is managed using Git and is hosted on Github.
|
||||
|
||||
git clone git://github.com/sphinx-doc/sphinx
|
||||
|
26
README.rst
26
README.rst
@ -2,7 +2,7 @@
|
||||
README for Sphinx
|
||||
=================
|
||||
|
||||
This is the Sphinx documentation generator, see http://sphinx-doc.org/.
|
||||
This is the Sphinx documentation generator, see http://www.sphinx-doc.org/.
|
||||
|
||||
|
||||
Installing
|
||||
@ -44,16 +44,15 @@ Releases are signed with following keys:
|
||||
Reading the docs
|
||||
================
|
||||
|
||||
After installing::
|
||||
You can read them online at <http://www.sphinx-doc.org/>.
|
||||
|
||||
Or, 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
|
||||
=======
|
||||
|
||||
@ -74,16 +73,7 @@ Continuous testing runs on travis:
|
||||
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>.
|
||||
See `CONTRIBUTING.rst`__
|
||||
|
||||
.. __: CONTRIBUTING.rst
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user