Skip to content

Commit fd31ec6

Browse files
authored
Use "Read the Docs" instead of ReadTheDocs (#565)
1 parent b01ab36 commit fd31ec6

File tree

2 files changed

+7
-7
lines changed

2 files changed

+7
-7
lines changed

README.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Features
2121
* Testing setup with ``unittest`` and ``python setup.py test`` or ``pytest``
2222
* Travis-CI_: Ready for Travis Continuous Integration testing
2323
* Tox_ testing: Setup to easily test for Python 3.5, 3.6, 3.7, 3.8
24-
* Sphinx_ docs: Documentation ready for generation with, for example, ReadTheDocs_
24+
* Sphinx_ docs: Documentation ready for generation with, for example, `Read the Docs`_
2525
* bump2version_: Pre-configured version bumping with a single command
2626
* Auto-release to PyPI_ when you push a new tag to master (optional)
2727
* Command line interface using Click (optional)
@@ -63,7 +63,7 @@ Then:
6363
* Register_ your project with PyPI.
6464
* Run the Travis CLI command `travis encrypt --add deploy.password` to encrypt your PyPI password in Travis config
6565
and activate automated deployment on PyPI when you push a new tag to master branch.
66-
* Add the repo to your ReadTheDocs_ account + turn on the ReadTheDocs service hook.
66+
* Add the repo to your `Read the Docs`_ account + turn on the Read the Docs service hook.
6767
* Release your package by pushing a new tag to master.
6868
* Add a `requirements.txt` file that specifies the packages you will need for
6969
your project and their versions. For more info see the `pip docs for requirements files`_.
@@ -143,7 +143,7 @@ make my own packaging experience better.
143143
.. _Travis-CI: http://travis-ci.org/
144144
.. _Tox: http://testrun.org/tox/
145145
.. _Sphinx: http://sphinx-doc.org/
146-
.. _ReadTheDocs: https://readthedocs.io/
146+
.. _Read the Docs: https://readthedocs.io/
147147
.. _`pyup.io`: https://pyup.io/
148148
.. _bump2version: https://github.com/c4urself/bump2version
149149
.. _Punch: https://github.com/lgiordani/punch

docs/tutorial.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -125,18 +125,18 @@ See :ref:`travis-pypi-setup` for more information.
125125
.. _`Travis CI com`: https://travis-ci.com/
126126

127127

128-
Step 6: Set Up ReadTheDocs
128+
Step 6: Set Up Read the Docs
129129
--------------------------
130130

131-
`ReadTheDocs`_ hosts documentation for the open source community. Think of it as Continuous Documentation.
131+
`Read the Docs`_ hosts documentation for the open source community. Think of it as Continuous Documentation.
132132

133-
Log into your account at `ReadTheDocs`_ . If you don't have one, create one and log into it.
133+
Log into your account at `Read the Docs`_ . If you don't have one, create one and log into it.
134134

135135
If you are not at your dashboard, choose the pull-down next to your username in the upper right, and select "My Projects". Choose the button to Import the repository and follow the directions.
136136

137137
Now your documentation will get rebuilt when you make documentation changes to your package.
138138

139-
.. _`ReadTheDocs`: https://readthedocs.org/
139+
.. _`Read the Docs`: https://readthedocs.org/
140140

141141
Step 7: Set Up pyup.io
142142
----------------------

0 commit comments

Comments
 (0)