[New-bugs-announce] [issue20393] Docs: mark deprecated items in the TOC

Zearin report at bugs.python.org
Sat Jan 25 22:29:29 CET 2014

New submission from Zearin:

When exploring the docs for the standard library, it’s frustrating to have an idea and look for the answer only to find out that an entire module (or package) has been deprecated _after_ I click on it. 

Can we have links to deprecated items on the Standard Library’s TOC page flagged?  

I see you’re using multiple CSS classes on some links.  I propose: 

- add a CSS class to flag links to deprecated items
- use something like the following CSS


 * Example 1: color 
.toctree-wrapper a.deprecated {
    color: #933;

 * Example 2: "badge" 
.toctree-wrapper a.deprecated:after {
	display: inline-block;
    content: "deprecated";
	margin: 0 1em;
	padding: 0 1ex !important;
	border-radius: 			1ex !important;
	font-size: x-small;
	background-color: #f66;
    color: #933;


Of course, since the CSS class '.deprecated' already exists, there's 2 options: 

1. the examples above are rewritten to use a different classname, or 
2. add the following CSS:


/* "Reset" .deprecated in a toctree context */
.toctree-wrapper a.deprecated {
    background: none;
	border: none;
	padding: 0;

/* << insert above example CSS here >> */


assignee: docs at python
components: Documentation
messages: 209239
nosy: docs at python, zearin
priority: normal
severity: normal
status: open
title: Docs: mark deprecated items in the TOC
type: enhancement
versions: Python 2.7, Python 3.1, Python 3.2, Python 3.3, Python 3.4, Python 3.5

Python tracker <report at bugs.python.org>

More information about the New-bugs-announce mailing list