freeCodeCamp / freeCodeCamp/devdocs

Fix header formatting in Sphinx-based docs

Abierto
#1,154 1 comentario 0 reacciones 0 asignados Ver en GitHub
docs/improvement
Lenguaje dominante
Ruby
Estrellas
39.5k
Forks
2.6k
Merge medio
4 d 32 min
PR fusionados (30 d)
13

Descripción

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)

Guía de contribución

Abrir la guía de contribución

Evaluación

Este issue todavía no se ha evaluado.

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.