Skip to content

Commit 5af0de3

Browse files
committed
Merge branch 'master' into separate-dev-docs
2 parents cdcecf0 + 4a19a9e commit 5af0de3

File tree

14 files changed

+35
-195
lines changed

14 files changed

+35
-195
lines changed

docs/user/advertising/ad-blocking.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@ and don't do creepy behavioral targeting.
1414

1515
Advertising is the single largest source of funding for Read the Docs.
1616
To keep our operations sustainable, we ask that you either
17-
:ref:`allow our Ethical Ads <advertising/ad-blocking:Allowing Ethical Ads>`
17+
:ref:`allow our EthicalAds <advertising/ad-blocking:Allowing EthicalAds>`
1818
or :ref:`go ad-free <advertising/ad-blocking:Going ad-free>`.
1919

2020

21-
Allowing Ethical Ads
22-
--------------------
21+
Allowing EthicalAds
22+
-------------------
2323

2424
If you use AdBlock or AdBlockPlus
2525
and you allow `acceptable ads`_ or `privacy-friendly acceptable ads`_

docs/user/tutorial/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ If you now click on :guilabel:`View docs`, you will see your documentation live!
208208
check out our `Sustainability page <https://readthedocs.org/sustainability/>`_.
209209

210210
If you don't see the ad, you might be using an ad blocker.
211-
Our Ethical Ads network respects your privacy, doesn't target you,
211+
Our EthicalAds network respects your privacy, doesn't target you,
212212
and tries to be as unobstrusive as possible,
213213
so we would like to kindly ask you to :doc:`not block us </advertising/ad-blocking>` |:heart:|
214214

readthedocs/api/v3/routers.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,16 @@ class DocsAPIRootView(APIRootView):
66

77
# Overridden only to add documentation for BrowsableAPIRenderer.
88

9+
# noqa
910
"""
10-
Read the Docs APIv3 root endpoint.
11+
Each request requires an `Authorization` HTTP header with `Token <your-token>`,
12+
find the token in [your account](/accounts/tokens/).
1113
12-
The API is browsable by sending the header ``Authorization: Token <token>`` on each request. You can find your Token at [https://readthedocs.org/accounts/tokens/](https://readthedocs.org/accounts/tokens/).
13-
14-
Read its full documentation at [https://docs.readthedocs.io/page/api/v3.html](https://docs.readthedocs.io/page/api/v3.html).
15-
""" # noqa
14+
Read the full documentation at <https://docs.readthedocs.io/page/api/v3.html>.
15+
"""
1616

1717
def get_view_name(self):
18-
return 'Read the Docs APIv3'
18+
return 'Read the Docs API v3'
1919

2020

2121
class DefaultRouterWithNesting(NestedRouterMixin, DefaultRouter):

readthedocs/api/v3/serializers.py

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -524,7 +524,7 @@ class ProjectUpdateSerializer(SettingsOverrideObject):
524524
_default_class = ProjectUpdateSerializerBase
525525

526526

527-
class ProjectSerializerBase(FlexFieldsModelSerializer):
527+
class ProjectSerializer(FlexFieldsModelSerializer):
528528

529529
"""
530530
Project serializer.
@@ -627,13 +627,6 @@ def get_subproject_of(self, obj):
627627
return None
628628

629629

630-
# FIXME: this override isn't needed, but tests will fail if removed.
631-
# We may have been relying on a weird behavior of using this class
632-
# as a base class of another.
633-
class ProjectSerializer(SettingsOverrideObject):
634-
_default_class = ProjectSerializerBase
635-
636-
637630
class SubprojectCreateSerializer(FlexFieldsModelSerializer):
638631

639632
"""Serializer used to define a Project as subproject of another Project."""

readthedocs/api/v3/tests/mixins.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@
2222
PRODUCTION_DOMAIN='readthedocs.org',
2323
USE_SUBDOMAIN=True,
2424
RTD_BUILD_MEDIA_STORAGE='readthedocs.rtd_tests.storage.BuildMediaFileSystemStorageTest',
25+
RTD_ALLOW_ORGANIZATIONS=False,
2526
)
2627
class APIEndpointMixin(TestCase):
2728

readthedocs/api/v3/tests/responses/projects-subprojects-detail.json

Lines changed: 0 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -35,55 +35,6 @@
3535
"url": "https://github.com/rtfd/subproject"
3636
},
3737
"slug": "subproject",
38-
"subproject_of": {
39-
"_links": {
40-
"_self": "https://readthedocs.org/api/v3/projects/project/",
41-
"builds": "https://readthedocs.org/api/v3/projects/project/builds/",
42-
"environmentvariables": "https://readthedocs.org/api/v3/projects/project/environmentvariables/",
43-
"redirects": "https://readthedocs.org/api/v3/projects/project/redirects/",
44-
"subprojects": "https://readthedocs.org/api/v3/projects/project/subprojects/",
45-
"superproject": "https://readthedocs.org/api/v3/projects/project/superproject/",
46-
"translations": "https://readthedocs.org/api/v3/projects/project/translations/",
47-
"versions": "https://readthedocs.org/api/v3/projects/project/versions/"
48-
},
49-
"created": "2019-04-29T10:00:00Z",
50-
"default_branch": "master",
51-
"default_version": "latest",
52-
"homepage": "http://project.com",
53-
"id": 1,
54-
"language": {
55-
"code": "en",
56-
"name": "English"
57-
},
58-
"modified": "2019-04-29T12:00:00Z",
59-
"name": "project",
60-
"programming_language": {
61-
"code": "words",
62-
"name": "Only Words"
63-
},
64-
"repository": {
65-
"type": "git",
66-
"url": "https://github.com/rtfd/project"
67-
}, "slug": "project",
68-
"subproject_of": null,
69-
"tags": [
70-
"tag",
71-
"project",
72-
"test"
73-
],
74-
"translation_of": null,
75-
"urls": {
76-
"builds": "https://readthedocs.org/projects/project/builds/",
77-
"documentation": "http://project.readthedocs.io/en/latest/",
78-
"home": "https://readthedocs.org/projects/project/",
79-
"versions": "https://readthedocs.org/projects/project/versions/"
80-
},
81-
"users": [
82-
{
83-
"username": "testuser"
84-
}
85-
]
86-
},
8738
"tags": [],
8839
"translation_of": null,
8940
"urls": {

readthedocs/api/v3/tests/responses/projects-subprojects-list.json

Lines changed: 0 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -40,55 +40,6 @@
4040
"url": "https://github.com/rtfd/subproject"
4141
},
4242
"slug": "subproject",
43-
"subproject_of": {
44-
"_links": {
45-
"_self": "https://readthedocs.org/api/v3/projects/project/",
46-
"builds": "https://readthedocs.org/api/v3/projects/project/builds/",
47-
"environmentvariables": "https://readthedocs.org/api/v3/projects/project/environmentvariables/",
48-
"redirects": "https://readthedocs.org/api/v3/projects/project/redirects/",
49-
"subprojects": "https://readthedocs.org/api/v3/projects/project/subprojects/",
50-
"superproject": "https://readthedocs.org/api/v3/projects/project/superproject/",
51-
"translations": "https://readthedocs.org/api/v3/projects/project/translations/",
52-
"versions": "https://readthedocs.org/api/v3/projects/project/versions/"
53-
},
54-
"created": "2019-04-29T10:00:00Z",
55-
"default_branch": "master",
56-
"default_version": "latest",
57-
"homepage": "http://project.com",
58-
"id": 1,
59-
"language": {
60-
"code": "en",
61-
"name": "English"
62-
},
63-
"modified": "2019-04-29T12:00:00Z",
64-
"name": "project",
65-
"programming_language": {
66-
"code": "words",
67-
"name": "Only Words"
68-
},
69-
"repository": {
70-
"type": "git",
71-
"url": "https://github.com/rtfd/project"
72-
}, "slug": "project",
73-
"subproject_of": null,
74-
"tags": [
75-
"tag",
76-
"project",
77-
"test"
78-
],
79-
"translation_of": null,
80-
"urls": {
81-
"builds": "https://readthedocs.org/projects/project/builds/",
82-
"documentation": "http://project.readthedocs.io/en/latest/",
83-
"home": "https://readthedocs.org/projects/project/",
84-
"versions": "https://readthedocs.org/projects/project/versions/"
85-
},
86-
"users": [
87-
{
88-
"username": "testuser"
89-
}
90-
]
91-
},
9243
"tags": [],
9344
"translation_of": null,
9445
"urls": {

readthedocs/api/v3/tests/responses/projects-subprojects-list_POST.json

Lines changed: 0 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -35,55 +35,6 @@
3535
"url": "https://github.com/rtfd/project"
3636
},
3737
"slug": "new-project",
38-
"subproject_of": {
39-
"_links": {
40-
"_self": "https://readthedocs.org/api/v3/projects/project/",
41-
"builds": "https://readthedocs.org/api/v3/projects/project/builds/",
42-
"environmentvariables": "https://readthedocs.org/api/v3/projects/project/environmentvariables/",
43-
"redirects": "https://readthedocs.org/api/v3/projects/project/redirects/",
44-
"subprojects": "https://readthedocs.org/api/v3/projects/project/subprojects/",
45-
"superproject": "https://readthedocs.org/api/v3/projects/project/superproject/",
46-
"translations": "https://readthedocs.org/api/v3/projects/project/translations/",
47-
"versions": "https://readthedocs.org/api/v3/projects/project/versions/"
48-
},
49-
"created": "2019-04-29T10:00:00Z",
50-
"default_branch": "master",
51-
"default_version": "latest",
52-
"homepage": "http://project.com",
53-
"id": 1,
54-
"language": {
55-
"code": "en",
56-
"name": "English"
57-
},
58-
"modified": "2019-04-29T12:00:00Z",
59-
"name": "project",
60-
"programming_language": {
61-
"code": "words",
62-
"name": "Only Words"
63-
},
64-
"repository": {
65-
"type": "git",
66-
"url": "https://github.com/rtfd/project"
67-
}, "slug": "project",
68-
"subproject_of": null,
69-
"tags": [
70-
"tag",
71-
"project",
72-
"test"
73-
],
74-
"translation_of": null,
75-
"urls": {
76-
"builds": "https://readthedocs.org/projects/project/builds/",
77-
"documentation": "http://project.readthedocs.io/en/latest/",
78-
"home": "https://readthedocs.org/projects/project/",
79-
"versions": "https://readthedocs.org/projects/project/versions/"
80-
},
81-
"users": [
82-
{
83-
"username": "testuser"
84-
}
85-
]
86-
},
8738
"tags": [],
8839
"translation_of": null,
8940
"urls": {

readthedocs/templates/rest_framework/api.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
{% load static %}
33

44
{% block branding %}
5-
<a class='navbar-brand' rel="nofollow" href='https://readthedocs.org'>
5+
<a class="navbar-brand" rel="nofollow" href="https://{{ PRODUCTION_DOMAIN }}">
66
Read the Docs
77
</a>
88
{% endblock %}

requirements/docker.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ argh==0.26.2
3030
tox==3.24.4
3131

3232
# AWS utilities to use against MinIO
33-
awscli==1.22.5
33+
awscli==1.22.23
3434

3535
# Used together with structlog to have nicer logs locally
36-
rich==10.14.0
36+
rich==10.16.0

0 commit comments

Comments
 (0)