From 3efd2df99b8abed8df982b62dcdfe680b1771ce1 Mon Sep 17 00:00:00 2001 From: shimizukawa Date: Sun, 18 Dec 2016 00:10:40 +0900 Subject: [PATCH] Reducing README.rst to avoid duplicated information in CONTRIBUTING.rst. --- CONTRIBUTING.rst | 3 +++ README.rst | 26 ++++++++------------------ 2 files changed, 11 insertions(+), 18 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index f29646550..d64f27702 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -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 diff --git a/README.rst b/README.rst index 509f2163c..de108895e 100644 --- a/README.rst +++ b/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 . + +Or, after installing:: cd doc make html Then, direct your browser to ``_build/html/index.html``. -Or read them online at . - - 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 - and the change to - CHANGES . +See `CONTRIBUTING.rst`__ + +.. __: CONTRIBUTING.rst +