Skip to content

Addons: make default root CSS selector a shared option #11767

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 11 commits into from
Nov 21, 2024
Merged

Addons: make default root CSS selector a shared option #11767

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
44587ab
Addons: make default root CSS selector a shared option
humitos Nov 14, 2024
eac7122
CSS `:is()` doesn't work in the backend
humitos Nov 20, 2024
9745c6c
Merge branch 'main' of github.com:readthedocs/readthedocs.org into hu…
humitos Nov 20, 2024
9944508
Make the default selector more generic
humitos Nov 20, 2024
f1a6c78
Update tests
humitos Nov 20, 2024
1ee65f6
Update migrations
humitos Nov 20, 2024
bde7538
Restore search CSS selector
humitos Nov 20, 2024
9bba9c2
Re-order selector to use most specific ones first
humitos Nov 20, 2024
14904c3
Move the `DEFAULT_ROOT_SELECTOR` to the frontend
humitos Nov 21, 2024
7cd3711
Update tests
humitos Nov 21, 2024
1d4360f
Placeholder
humitos Nov 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 5 additions & 12 deletions readthedocs/projects/forms.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -653,19 +653,16 @@ class Meta:
fields = (
"enabled",
"project",
"options_root_selector",
"analytics_enabled",
"doc_diff_enabled",
"doc_diff_root_selector",
"flyout_enabled",
"flyout_sorting",
"flyout_sorting_latest_stable_at_beginning",
"flyout_sorting_custom_pattern",
"hotkeys_enabled",
"search_enabled",
"linkpreviews_enabled",
"linkpreviews_root_selector",
"linkpreviews_doctool_name",
"linkpreviews_doctool_version",
"notifications_enabled",
"notifications_show_on_latest",
"notifications_show_on_non_stable",
Expand All @@ -681,16 +678,12 @@ class Meta:
),
"notifications_show_on_latest": _("Show a notification on latest version"),
"linkpreviews_enabled": _("Enabled"),
"linkpreviews_root_selector": _("Root selector"),
"linkpreviews_doctool_name": _("Documentation tool name"),
"linkpreviews_doctool_version": _("Documentation tool version"),
"options_root_selector": _("CSS main content selector"),
}

widgets = {
"doc_diff_root_selector": forms.TextInput(
attrs={"placeholder": AddonsConfig.DOC_DIFF_DEFAULT_ROOT_SELECTOR}
),
"linkpreviews_root_selector": forms.TextInput(
attrs={"placeholder": AddonsConfig.LINKPREVIEWS_DEFAULT_ROOT_SELECTOR}
"options_root_selector": forms.TextInput(
attrs={"placeholder": "[role=main]"}
),
}

Expand Down
25 changes: 25 additions & 0 deletions readthedocs/projects/migrations/0137_use_generic_root_selector.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Generated by Django 4.2.16 on 2024-11-20 12:35

from django.db import migrations, models
from django_safemigrate import Safe


class Migration(migrations.Migration):
safe = Safe.before_deploy

dependencies = [
('projects', '0136_addons_customscript_notnull'),
]

operations = [
migrations.AddField(
model_name='addonsconfig',
name='options_root_selector',
field=models.CharField(blank=True, help_text='CSS selector for the main content of the page. Leave it blank for auto-detect.', max_length=128, null=True),
),
migrations.AddField(
model_name='historicaladdonsconfig',
name='options_root_selector',
field=models.CharField(blank=True, help_text='CSS selector for the main content of the page. Leave it blank for auto-detect.', max_length=128, null=True),
),
]
47 changes: 47 additions & 0 deletions readthedocs/projects/migrations/0138_remove_old_fields.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Generated by Django 4.2.16 on 2024-11-20 12:35

from django.db import migrations
from django_safemigrate import Safe


class Migration(migrations.Migration):
safe = Safe.after_deploy

dependencies = [
('projects', '0137_use_generic_root_selector'),
]

operations = [
migrations.RemoveField(
model_name='addonsconfig',
name='doc_diff_root_selector',
),
migrations.RemoveField(
model_name='addonsconfig',
name='linkpreviews_doctool_name',
),
migrations.RemoveField(
model_name='addonsconfig',
name='linkpreviews_doctool_version',
),
migrations.RemoveField(
model_name='addonsconfig',
name='linkpreviews_root_selector',
),
migrations.RemoveField(
model_name='historicaladdonsconfig',
name='doc_diff_root_selector',
),
migrations.RemoveField(
model_name='historicaladdonsconfig',
name='linkpreviews_doctool_name',
),
migrations.RemoveField(
model_name='historicaladdonsconfig',
name='linkpreviews_doctool_version',
),
migrations.RemoveField(
model_name='historicaladdonsconfig',
name='linkpreviews_root_selector',
),
]
32 changes: 7 additions & 25 deletions readthedocs/projects/models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,13 +144,6 @@ class AddonsConfig(TimeStampedModel):
Everything is enabled by default.
"""

DOC_DIFF_DEFAULT_ROOT_SELECTOR = "[role=main]"
LINKPREVIEWS_DEFAULT_ROOT_SELECTOR = "[role=main] a.internal"
LINKPREVIEWS_DOCTOOL_NAME_CHOICES = (
("sphinx", "Sphinx"),
("other", "Other"),
)

# Model history
history = ExtraHistoricalRecords()

Expand All @@ -167,6 +160,13 @@ class AddonsConfig(TimeStampedModel):
help_text="Enable/Disable all the addons on this project",
)

options_root_selector = models.CharField(
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't need to work on this now, but I do remember that we mentioned that this will likely change across versions for a project (eg. someone changes Sphinx themes, or even doc tools across versions). I do wonder if a v2 of this feature adds something like this to a Version, which can be set via the .readthedocs.yaml?

I don't want to get into that rabbit role in this initial work, but I do think it's something we'll likely hit at some point.

The order of precedence would then be:

Version > Project > Default Client Logic.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I think we will want to have addons configs per version at some point 👍🏼 -- I agree it's something to keep in mind and consider in the future.

null=True,
blank=True,
max_length=128,
help_text="CSS selector for the main content of the page. Leave it blank for auto-detect.",
)

# Whether or not load addons library when the requested page is embedded (e.g. inside an iframe)
# https://github.com/readthedocs/addons/pull/415
options_load_when_embedded = models.BooleanField(default=False)
Expand All @@ -181,12 +181,6 @@ class AddonsConfig(TimeStampedModel):
doc_diff_enabled = models.BooleanField(default=True)
doc_diff_show_additions = models.BooleanField(default=True)
doc_diff_show_deletions = models.BooleanField(default=True)
doc_diff_root_selector = models.CharField(
null=True,
blank=True,
max_length=128,
help_text="CSS selector for the main content of the page",
)

# EthicalAds
ethicalads_enabled = models.BooleanField(default=True)
Expand Down Expand Up @@ -242,18 +236,6 @@ class AddonsConfig(TimeStampedModel):

# Link Previews
linkpreviews_enabled = models.BooleanField(default=False)
linkpreviews_root_selector = models.CharField(null=True, blank=True, max_length=128)
linkpreviews_doctool_name = models.CharField(
choices=LINKPREVIEWS_DOCTOOL_NAME_CHOICES,
null=True,
blank=True,
max_length=128,
)
linkpreviews_doctool_version = models.CharField(
null=True,
blank=True,
max_length=128,
)


class AddonSearchFilter(TimeStampedModel):
Expand Down
11 changes: 3 additions & 8 deletions readthedocs/proxito/tests/responses/v1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,8 @@
},
"addons": {
"options": {
"load_when_embedded": false
"load_when_embedded": false,
"root_selector": null
},
"analytics": {
"enabled": false,
Expand All @@ -148,7 +149,6 @@
"doc_diff": {
"enabled": true,
"base_url": "https://project.dev.readthedocs.io/en/latest/index.html",
"root_selector": null,
"inject_styles": true,
"base_host": "",
"base_page": ""
Expand All @@ -169,12 +169,7 @@
"src": null
},
"linkpreviews": {
"enabled": false,
"root_selector": "[role=main] a.internal",
"doctool": {
"name": null,
"version": null
}
"enabled": false
}
}
}
8 changes: 0 additions & 8 deletions readthedocs/proxito/tests/test_hosting.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -729,9 +729,6 @@ def test_linkpreviews(self):
)

addons.linkpreviews_enabled = True
addons.linkpreviews_root_selector = "[role=main] a"
addons.linkpreviews_doctool_name = "sphinx"
addons.linkpreviews_doctool_version = "8.0.1"
addons.save()

r = self.client.get(
Expand All @@ -748,11 +745,6 @@ def test_linkpreviews(self):
)
expected = {
"enabled": True,
"root_selector": "[role=main] a",
"doctool": {
"name": "sphinx",
"version": "8.0.1",
},
}

assert r.status_code == 200
Expand Down
8 changes: 1 addition & 7 deletions readthedocs/proxito/views/hosting.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -456,6 +456,7 @@ def _v1(self, project, version, build, filename, url, request):
"addons": {
"options": {
"load_when_embedded": project.addons.options_load_when_embedded,
"root_selector": project.addons.options_root_selector,
},
"analytics": {
"enabled": project.addons.analytics_enabled,
Expand Down Expand Up @@ -519,12 +520,6 @@ def _v1(self, project, version, build, filename, url, request):
},
"linkpreviews": {
"enabled": project.addons.linkpreviews_enabled,
"root_selector": project.addons.linkpreviews_root_selector
or project.addons.LINKPREVIEWS_DEFAULT_ROOT_SELECTOR,
"doctool": {
"name": project.addons.linkpreviews_doctool_name,
"version": project.addons.linkpreviews_doctool_version,
},
},
"hotkeys": {
"enabled": project.addons.hotkeys_enabled,
Expand Down Expand Up @@ -594,7 +589,6 @@ def _v1(self, project, version, build, filename, url, request):
)
if filename
else None,
"root_selector": project.addons.doc_diff_root_selector,
"inject_styles": True,
# NOTE: `base_host` and `base_page` are not required, since
# we are constructing the `base_url` in the backend instead
Expand Down