Skip to content

Commit f8dd0e0

Browse files
ericholscherericholscher
committed
Merge tag '5.0.0' into rel
2 parents c099d5c + ce0e997 commit f8dd0e0

File tree

102 files changed

+1141
-5434
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

102 files changed

+1141
-5434
lines changed

‎CHANGELOG.rst

+38
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,41 @@
1+
Version 5.0.0
2+
-------------
3+
4+
:Date: May 12, 2020
5+
6+
This release includes two large changes, one that is breaking and requires a major version upgrade:
7+
8+
* We have removed our deprecated doc serving code that used ``core/views``, ``core/symlinks``, and ``builds/syncers`` (`#6535 <https://github.com/readthedocs/readthedocs.org/pull/6535>`__). All doc serving should now be done via ``proxito``. In production this has been the case for over a month, we have now removed the deprecated code from the codebase.
9+
* We did a large documentation refactor that should make things nicer to read and highlights more of our existing features. This is the first of a series of new documentation additions we have planned
10+
11+
12+
* `@ericholscher <https://github.com/ericholscher>`__: Fix the caching of featured projects (`#7054 <https://github.com/readthedocs/readthedocs.org/pull/7054>`__)
13+
* `@ericholscher <https://github.com/ericholscher>`__: Docs: Refactor and simplify our docs (`#7052 <https://github.com/readthedocs/readthedocs.org/pull/7052>`__)
14+
* `@stsewd <https://github.com/stsewd>`__: Mention using ssh URLs when using private submodules (`#7046 <https://github.com/readthedocs/readthedocs.org/pull/7046>`__)
15+
* `@ericholscher <https://github.com/ericholscher>`__: Show project slug in Version admin (`#7042 <https://github.com/readthedocs/readthedocs.org/pull/7042>`__)
16+
* `@stsewd <https://github.com/stsewd>`__: List apiv3 first (`#7041 <https://github.com/readthedocs/readthedocs.org/pull/7041>`__)
17+
* `@stsewd <https://github.com/stsewd>`__: Remove CELERY_ROUTER flag (`#7040 <https://github.com/readthedocs/readthedocs.org/pull/7040>`__)
18+
* `@stsewd <https://github.com/stsewd>`__: Search: remove unused taxonomy field (`#7033 <https://github.com/readthedocs/readthedocs.org/pull/7033>`__)
19+
* `@agjohnson <https://github.com/agjohnson>`__: Use a high time limit for celery build task (`#7029 <https://github.com/readthedocs/readthedocs.org/pull/7029>`__)
20+
* `@ericholscher <https://github.com/ericholscher>`__: Clean up build admin to make list display match search (`#7028 <https://github.com/readthedocs/readthedocs.org/pull/7028>`__)
21+
* `@stsewd <https://github.com/stsewd>`__: Task Router: check for None (`#7027 <https://github.com/readthedocs/readthedocs.org/pull/7027>`__)
22+
* `@stsewd <https://github.com/stsewd>`__: Implement repo_exists for all VCS backends (`#7025 <https://github.com/readthedocs/readthedocs.org/pull/7025>`__)
23+
* `@stsewd <https://github.com/stsewd>`__: Mkdocs: Index pages without anchors (`#7024 <https://github.com/readthedocs/readthedocs.org/pull/7024>`__)
24+
* `@agjohnson <https://github.com/agjohnson>`__: Move docker limits back to setting (`#7023 <https://github.com/readthedocs/readthedocs.org/pull/7023>`__)
25+
* `@humitos <https://github.com/humitos>`__: Fix typo (`#7022 <https://github.com/readthedocs/readthedocs.org/pull/7022>`__)
26+
* `@stsewd <https://github.com/stsewd>`__: Fix linter (`#7021 <https://github.com/readthedocs/readthedocs.org/pull/7021>`__)
27+
* `@ericholscher <https://github.com/ericholscher>`__: Release 4.1.8 (`#7020 <https://github.com/readthedocs/readthedocs.org/pull/7020>`__)
28+
* `@ericholscher <https://github.com/ericholscher>`__: Cleanup unresolver logging (`#7019 <https://github.com/readthedocs/readthedocs.org/pull/7019>`__)
29+
* `@stsewd <https://github.com/stsewd>`__: Document about next when using a secret link (`#7015 <https://github.com/readthedocs/readthedocs.org/pull/7015>`__)
30+
* `@stsewd <https://github.com/stsewd>`__: Remove unused field project.version_privacy_level (`#7011 <https://github.com/readthedocs/readthedocs.org/pull/7011>`__)
31+
* `@ericholscher <https://github.com/ericholscher>`__: Add proxito headers to redirect responses (`#7007 <https://github.com/readthedocs/readthedocs.org/pull/7007>`__)
32+
* `@stsewd <https://github.com/stsewd>`__: Make hidden field not null (`#6996 <https://github.com/readthedocs/readthedocs.org/pull/6996>`__)
33+
* `@humitos <https://github.com/humitos>`__: Show a list of packages installed on environment (`#6992 <https://github.com/readthedocs/readthedocs.org/pull/6992>`__)
34+
* `@eric-wieser <https://github.com/eric-wieser>`__: Ensure invoked Sphinx matches importable one (`#6965 <https://github.com/readthedocs/readthedocs.org/pull/6965>`__)
35+
* `@ericholscher <https://github.com/ericholscher>`__: Add an unresolver similar to our resolver (`#6944 <https://github.com/readthedocs/readthedocs.org/pull/6944>`__)
36+
* `@KengoTODA <https://github.com/KengoTODA>`__: Replace "PROJECT" with project object (`#6878 <https://github.com/readthedocs/readthedocs.org/pull/6878>`__)
37+
* `@humitos <https://github.com/humitos>`__: Remove code replaced by El Proxito and stateless servers (`#6535 <https://github.com/readthedocs/readthedocs.org/pull/6535>`__)
38+
139
Version 4.1.8
240
-------------
341

‎docs/.rstcheck.cfg

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
[rstcheck]
22
ignore_directives=automodule,http:get,tabs,tab,prompt,http:patch,http:post,http:put,http:delete
33
ignore_roles=djangosetting,setting,featureflags,buildpyversions
4+
ignore_substitutions=org_brand,com_brand
45
# This error needs to be ignored for now
56
# See: https://github.com/myint/rstcheck/issues/19
67
ignore_messages=(Hyperlink target ".*" is not referenced)

‎docs/_ext/djangodocs.py

+6
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,9 @@ def setup(app):
44
rolename="setting",
55
indextemplate="pair: %s; setting",
66
)
7+
8+
return {
9+
'version': 'builtin',
10+
'parallel_read_safe': True,
11+
'parallel_write_safe': True,
12+
}

‎docs/_static/images/guides/search-analytics-demo.png

-424 KB
Binary file not shown.

‎docs/_static/images/search-analytics-demo.png

248 KB
Loading

‎docs/about.rst

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
About Read the Docs
2+
===================
3+
4+
Read the Docs is a C Corporation registered in Oregon.
5+
Our bootstrapped company is owned and fully controlled by the founders,
6+
and fully funded by our customers and advertisers.
7+
This allows us to **focus 100% on our users**.
8+
9+
We have two main sources of revenue:
10+
11+
* |com_brand| - where we `provide <https://readthedocs.com>`__ a valuable paid service to companies.
12+
* |org_brand| - where we provide a free service to the open source community, funded via :doc:`/advertising/ethical-advertising`.
13+
14+
We believe that having both paying customers and ethical advertising is the best way to create a sustainable platform for our users.
15+
We have built something that we expect to last a long time,
16+
and we are able to make decisions based only on the best interest of our community and customers.
17+
18+
All of the source code for Read the Docs is open source.
19+
You are welcome to :doc:`contribute </contribute>` the features you want or run your own instance.
20+
We should note that we generally only support our hosted versions as a matter of :doc:`our philosophy </open-source-philosophy>`.
21+
22+
We owe a great deal to the open source community that we are a part of,
23+
so we provide free ads via our :ref:`community ads <advertising/ethical-advertising:Community Ads>` program.
24+
This allows us to give back to the communities and projects that we support and depend on.
25+
26+
We are proud about the way we manage our company and products,
27+
and are glad to have you on board with us in this :doc:`great documentation journey </story>`.

‎docs/api/index.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ from Read the Docs.
88

99

1010
.. toctree::
11-
:maxdepth: 3
11+
:maxdepth: 3
1212

13-
v2
14-
v3
13+
v3
14+
v2

‎docs/api/v3.rst

+112-2
Original file line numberDiff line numberDiff line change
@@ -103,12 +103,67 @@ Projects list
103103
"count": 25,
104104
"next": "/api/v3/projects/?limit=10&offset=10",
105105
"previous": null,
106-
"results": ["PROJECT"]
106+
"results": [{
107+
"id": 12345,
108+
"name": "Pip",
109+
"slug": "pip",
110+
"created": "2010-10-23T18:12:31+00:00",
111+
"modified": "2018-12-11T07:21:11+00:00",
112+
"language": {
113+
"code": "en",
114+
"name": "English"
115+
},
116+
"programming_language": {
117+
"code": "py",
118+
"name": "Python"
119+
},
120+
"repository": {
121+
"url": "https://github.com/pypa/pip",
122+
"type": "git"
123+
},
124+
"default_version": "stable",
125+
"default_branch": "master",
126+
"subproject_of": null,
127+
"translation_of": null,
128+
"urls": {
129+
"documentation": "http://pip.pypa.io/en/stable/",
130+
"home": "https://pip.pypa.io/"
131+
},
132+
"tags": [
133+
"disutils",
134+
"easy_install",
135+
"egg",
136+
"setuptools",
137+
"virtualenv"
138+
],
139+
"users": [
140+
{
141+
"username": "dstufft"
142+
}
143+
],
144+
"active_versions": {
145+
"stable": "{VERSION}",
146+
"latest": "{VERSION}",
147+
"19.0.2": "{VERSION}"
148+
},
149+
"_links": {
150+
"_self": "/api/v3/projects/pip/",
151+
"versions": "/api/v3/projects/pip/versions/",
152+
"builds": "/api/v3/projects/pip/builds/",
153+
"subprojects": "/api/v3/projects/pip/subprojects/",
154+
"superproject": "/api/v3/projects/pip/superproject/",
155+
"redirects": "/api/v3/projects/pip/redirects/",
156+
"translations": "/api/v3/projects/pip/translations/"
157+
}
158+
}]
107159
}
108160

109161
:query string language: language code as ``en``, ``es``, ``ru``, etc.
110162
:query string programming_language: programming language code as ``py``, ``js``, etc.
111163

164+
The ``results`` in response is an array of project data,
165+
which is same as :http:get:`/api/v3/projects/(string:project_slug)/`.
166+
112167

113168
Project details
114169
+++++++++++++++
@@ -863,9 +918,64 @@ Translations listing
863918
"count": 25,
864919
"next": "/api/v3/projects/pip/translations/?limit=10&offset=10",
865920
"previous": null,
866-
"results": ["PROJECT"]
921+
"results": [{
922+
"id": 12345,
923+
"name": "Pip",
924+
"slug": "pip",
925+
"created": "2010-10-23T18:12:31+00:00",
926+
"modified": "2018-12-11T07:21:11+00:00",
927+
"language": {
928+
"code": "en",
929+
"name": "English"
930+
},
931+
"programming_language": {
932+
"code": "py",
933+
"name": "Python"
934+
},
935+
"repository": {
936+
"url": "https://github.com/pypa/pip",
937+
"type": "git"
938+
},
939+
"default_version": "stable",
940+
"default_branch": "master",
941+
"subproject_of": null,
942+
"translation_of": null,
943+
"urls": {
944+
"documentation": "http://pip.pypa.io/en/stable/",
945+
"home": "https://pip.pypa.io/"
946+
},
947+
"tags": [
948+
"disutils",
949+
"easy_install",
950+
"egg",
951+
"setuptools",
952+
"virtualenv"
953+
],
954+
"users": [
955+
{
956+
"username": "dstufft"
957+
}
958+
],
959+
"active_versions": {
960+
"stable": "{VERSION}",
961+
"latest": "{VERSION}",
962+
"19.0.2": "{VERSION}"
963+
},
964+
"_links": {
965+
"_self": "/api/v3/projects/pip/",
966+
"versions": "/api/v3/projects/pip/versions/",
967+
"builds": "/api/v3/projects/pip/builds/",
968+
"subprojects": "/api/v3/projects/pip/subprojects/",
969+
"superproject": "/api/v3/projects/pip/superproject/",
970+
"redirects": "/api/v3/projects/pip/redirects/",
971+
"translations": "/api/v3/projects/pip/translations/"
972+
}
973+
}]
867974
}
868975

976+
The ``results`` in response is an array of project data,
977+
which is same as :http:get:`/api/v3/projects/(string:project_slug)/`.
978+
869979

870980
Redirects
871981
~~~~~~~~~

‎docs/automatic-redirects.rst

+19-20
Original file line numberDiff line numberDiff line change
@@ -4,29 +4,44 @@ Automatic Redirects
44
Read the Docs supports redirecting certain URLs automatically.
55
This is an overview of the set of redirects that are fully supported and will work into the future.
66

7+
Redirecting to a Page
8+
---------------------
9+
10+
You can link to a specific page and have it redirect to your default version.
11+
This is done with the ``/page/`` URL prefix.
12+
You can reach this page by going to https://docs.readthedocs.io/page/automatic-redirects.html.
13+
14+
This allows you to create links that are always up to date.
15+
16+
Another way to handle this is the ``latest`` version.
17+
You can set your ``latest`` version to a specific version and just always link to ``latest``.
18+
You can read more about this in our :doc:`versions </versions>` page.
19+
720
Root URL
821
--------
922

1023
A link to the root of your documentation will redirect to the *default version*,
1124
as set in your project settings.
1225
For example::
1326

14-
pip.readthedocs.io -> pip.readthedocs.io/en/latest/
15-
www.pip-installer.org -> www.pip-installer.org/en/latest
27+
docs.readthedocs.io -> docs.readthedocs.io/en/latest/
28+
www.pip-installer.org -> www.pip-installer.org/en/latest/
1629

1730
This only works for the root URL, not for internal pages. It's designed to redirect people from http://pip.readthedocs.io/ to the default version of your documentation, since serving up a 404 here would be a pretty terrible user experience. (If your "develop" branch was designated as your default version, then it would redirect to http://pip.readthedocs.io/en/develop.) But, it's not a universal redirecting solution. So, for example, a link to an internal page like http://pip.readthedocs.io/usage.html doesn't redirect to http://pip.readthedocs.io/en/latest/usage.html.
1831

1932
The reasoning behind this is that RTD organizes the URLs for docs so that multiple translations and multiple versions of your docs can be organized logically and consistently for all projects that RTD hosts. For the way that RTD views docs, http://pip.readthedocs.io/en/latest/ is the root directory for your default documentation in English, not http://pip.readthedocs.io/. Just like http://pip.readthedocs.io/en/develop/ is the root for your development documentation in English.
2033

2134
Among all the multiple versions of docs, you can choose which is the "default" version for RTD to display, which usually corresponds to the git branch of the most recent official release from your project.
2235

23-
rtfd.org
36+
rtfd.io
2437
~~~~~~~~
2538

26-
Links to rtfd.org are treated the same way as above.
39+
Links to rtfd.io are treated the same way as above.
2740
They redirect the root URL to the default version of the project.
2841
They are intended to be easy and short for people to type.
2942

43+
You can reach these docs at https://docs.rtfd.io.
44+
3045
Supported Top-Level Redirects
3146
-----------------------------
3247

@@ -43,19 +58,3 @@ The main challenge of URL routing in Read the Docs is handling redirects correct
4358

4459
The language redirect will work for any of the defined ``LANGUAGE_CODES`` we support.
4560
The version redirect will work for supported versions.
46-
47-
Redirecting to a Page
48-
---------------------
49-
50-
You can link to a specific page and have it redirect to your default version.
51-
This is done with the ``/page/`` URL.
52-
For example::
53-
54-
pip.readthedocs.io/page/quickstart.html -> pip.readthedocs.io/en/latest/quickstart.html
55-
www.pip-installer.org/page/quickstart.html -> www.pip-installer.org/en/latest/quickstart.html
56-
57-
This allows you to create links that are always up to date.
58-
59-
Another way to handle this is the *latest* version.
60-
You can set your ``latest`` version to a specific version and just always link to latest.
61-

0 commit comments

Comments
 (0)