Repository navigation
Add description meta tags to docs.python.org #84426
Description
| BPO | 40245 |
|---|---|
| Nosy | @petdance, @0az |
Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.
Show more details
GitHub fields:
assignee = None
closed_at = None
created_at = <Date 2020-04-10.16:38:25.608>
labels = ['type-feature', 'docs']
title = 'Add description meta tags to docs.python.org'
updated_at = <Date 2020-04-10.17:46:14.716>
user = 'https://github.com/0az'bugs.python.org fields:
activity = <Date 2020-04-10.17:46:14.716>
actor = 'petdance'
assignee = 'docs@python'
closed = False
closed_date = None
closer = None
components = ['Documentation']
creation = <Date 2020-04-10.16:38:25.608>
creator = '0az'
dependencies = []
files = []
hgrepos = []
issue_num = 40245
keywords = []
message_count = 1.0
messages = ['366138']
nosy_count = 3.0
nosy_names = ['docs@python', 'petdance', '0az']
pr_nums = []
priority = 'normal'
resolution = None
stage = None
status = 'open'
superseder = None
type = 'enhancement'
url = 'https://bugs.python.org/issue40245'
versions = []
Activity
0az commentedon Apr 10, 2020
This isn't a particularly high priority, but it would be nice to have the first paragraph of docs pages show up when searched or posted in Slack, Discord, Twitter, etc. This is done through the description meta tag, as well as Open Graph, etc. As the description meta tag covers most of the potential use cases, the others can wait.
What implementing this would entail is either manual addition of meta tags, or an automatic transform step that grabs the first paragraph of the relevant RST source. [1]
http://www.sphinx-doc.org/en/master/extdev/appapi.html#sphinx.application.Sphinx.add_transform
hugovk commentedon Aug 4, 2023
Description meta tags have been added by #99931.
For example, https://docs.python.org/3/library/sys_path_init.html has: