classification
Title: Add description meta tags to docs.python.org
Type: enhancement Stage:
Components: Documentation Versions:
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: 0az, docs@python, petdance
Priority: normal Keywords:

Created on 2020-04-10 16:38 by 0az, last changed 2020-04-10 17:46 by petdance.

Messages (1)
msg366138 - (view) Author: Andrew Zhou (0az) Date: 2020-04-10 16:38
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
History
Date User Action Args
2020-04-10 17:46:14petdancesetnosy: + petdance
2020-04-10 16:38:250azcreate