forked from sphinx-doc/sphinx
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Reducing README.rst to avoid duplicated information in CONTRIBUTING.rst.
- Loading branch information
1 parent
79fa283
commit 3efd2df
Showing
2 changed files
with
11 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
|
@@ -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 | ||
======= | ||
|
||
|
@@ -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 | ||
|