freeCodeCamp / freeCodeCamp/devdocs

Fix header formatting in Sphinx-based docs

Offen
#1,154 1 Kommentar 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
docs/improvement
Vorherrschende Sprache
Ruby
Sterne
39.5k
Forks
2.6k
Ø Merge
4 T. 32 Min.
Gemergte PRs (30 T.)
13

Beschreibung

The Sphinx `clean_html` filter removes all formatting from `

` elements:

https://github.com/freeCodeCamp/devdocs/blob/58a0120697a701f2cb9ca87061ec7ef6fde3b013/lib/docs/filters/sphinx/clean_html.rb#L64

However, this is not entirely desirable since the formatting makes things look better. For example, the [header for `BaseException`](http://devdocs.localhost/python~3.8/library/exceptions#BaseException) ([original](https://docs.python.org/3.8/library/exceptions.html#BaseException)) is transformed from this:

> *exception* **`BaseException`**

to this:
> `exception BaseException`

cc @Thibaut since you might have a reason for implementing this this way. (no worries if you don’t reply though)

Beitragsleitfaden

Beitragsleitfaden öffnen

Bewertung

Dieses Issue wurde noch nicht bewertet.

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.