Skip to content

Commit c42586f

Browse files
authored
Merge pull request #8608 from readthedocs/clarify-docs
Clarify docs
2 parents fb99da9 + ee8549c commit c42586f

File tree

4 files changed

+20
-11
lines changed

4 files changed

+20
-11
lines changed

.github/CODEOWNERS

+2
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
11
* @readthedocs/backend
2+
3+
docs/* @readthedocs/advocacy

docs/config-file/v2.rst

+6-4
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ Below is an example YAML file which shows the most common configuration options:
3535
sphinx:
3636
configuration: docs/conf.py
3737
38-
# Optionally build your docs in additional formats such as PDF
38+
# If using Sphinx, optionally build your docs in additional formats such as PDF
3939
# formats:
4040
# - pdf
4141
@@ -103,10 +103,11 @@ Example:
103103
formats
104104
~~~~~~~
105105

106-
Formats of the documentation to be built.
106+
Additional formats of the documentation to be built,
107+
apart from the default HTML.
107108

108109
:Type: ``list``
109-
:Options: ``htmlzip``, ``pdf``, ``epub``
110+
:Options: ``htmlzip``, ``pdf``, ``epub``, ``all``
110111
:Default: ``[]``
111112

112113
Example:
@@ -140,7 +141,8 @@ Example:
140141
141142
.. warning::
142143

143-
``pdf``, ``epub``, and ``htmlzip`` output is not supported when using MkDocs.
144+
At the moment, only Sphinx supports additional formats.
145+
``pdf``, ``epub``, and ``htmlzip`` output is not yet supported when using MkDocs.
144146

145147
python
146148
~~~~~~

docs/intro/import-guide.rst

+2
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ Importing Your Documentation
88
To import a public documentation repository, visit your `Read the Docs dashboard`_ and click Import_.
99
For private repositories, please use :doc:`Read the Docs for Business </commercial/index>`.
1010

11+
Automatically import your docs
12+
------------------------------
1113

1214
If you have :doc:`connected your Read the Docs account <../connected-accounts>` to GitHub, Bitbucket, or GitLab,
1315
you will see a list of your repositories that we are able to import.

docs/single_version.rst

+10-7
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,19 @@ Enabling
1313
~~~~~~~~
1414

1515
You can toggle the "Single Version" option on or off for your project in the Project Admin page.
16-
Check your :guilabel:`dashboard` for a list of your projects.
16+
Check your :term:`dashboard` for a list of your projects.
1717

1818
Effects
1919
~~~~~~~
2020

21-
Links generated on Read the Docs will now point to the proper URL. For example,
22-
if pip was set as a "Single Version" project, then links to its documentation would point to
23-
``http://pip.readthedocs.io/`` rather than the default ``http://pip.readthedocs.io/en/latest/``.
21+
Links pointing to the :term:`root URL` of the project will now point to the proper URL.
22+
For example, if pip was set as a "Single Version" project,
23+
then links to its documentation would point to ``https://pip.readthedocs.io/``
24+
rather than redirecting to ``https://pip.readthedocs.io/en/latest/``.
2425

25-
Documentation at ``/<language>/<default_version>/`` will still be served for backwards compatibility reasons.
26-
However, our usage of :ref:`custom_domains:Canonical URLs` should stop these from being indexed by Google.
26+
.. warning::
2727

28-
.. _dashboard: https://readthedocs.org/dashboard/
28+
Documentation at ``/<language>/<default_version>/`` will stop working.
29+
Remember to set :ref:`custom_domains:Canonical URLs`
30+
to tell search engines like Google what to index,
31+
and to create :doc:`user-defined-redirects` to avoid broken incoming links.

0 commit comments

Comments
 (0)