Issue 20393: Docs: mark deprecated items in the TOC (original) (raw)

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 >> */