Skip to content

Add description meta tags to docs.python.org #84426

Closed
Closed
Add description meta tags to docs.python.org#84426
Labels
docsDocumentation in the Doc dirtype-featureA feature request or enhancement

Description

@0az
0az
mannequin
opened on Apr 10, 2020
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

  1. 0az commented on Apr 10, 2020

    @0az
    0azmannequin
    on Apr 10, 2020
    MannequinAuthor

    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

  2. 0az
    assigned
    docspython
    on Apr 10, 2020
  3. 0az
    added
    docsDocumentation in the Doc dir
    type-featureA feature request or enhancement
    on Apr 10, 2020
  4. 0az
    assigned
    docspython
    on Apr 10, 2020
  5. 0az
    added
    docsDocumentation in the Doc dir
    type-featureA feature request or enhancement
    on Apr 10, 2020
  6. ezio-melotti
    transferred this issue fromon Apr 10, 2022

  7. hugovk commented on Aug 4, 2023

    @hugovk
    hugovk
    on Aug 4, 2023
    Member

    Description meta tags have been added by #99931.

    For example, https://docs.python.org/3/library/sys_path_init.html has:

    <meta name="description" content="A module search path is initialized when Python starts. This module search path may be accessed at sys.path. The first entry in the module search path is the directory that contains the input scrip..." />
  8. hugovk
    closed this as completedon Aug 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    docsDocumentation in the Doc dirtype-featureA feature request or enhancement

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions