Skip to content

Commit

Permalink
Reducing README.rst to avoid duplicated information in CONTRIBUTING.rst.
Browse files Browse the repository at this point in the history
  • Loading branch information
shimizukawa committed Dec 17, 2016
1 parent 79fa283 commit 3efd2df
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 18 deletions.
3 changes: 3 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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:https://github.com/sphinx-doc/sphinx
Expand Down
26 changes: 8 additions & 18 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
README for Sphinx
=================

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


Installing
Expand Down Expand Up @@ -44,16 +44,15 @@ Releases are signed with following keys:
Reading the docs
================

After installing::
You can read them online at <https://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 <https://sphinx-doc.org/>.


Testing
=======

Expand All @@ -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 [email protected].
#. 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

0 comments on commit 3efd2df

Please sign in to comment.