freeCodeCamp / freeCodeCamp/devdocs

Fix header formatting in Sphinx-based docs

Đang mở
#1,154 1 bình luận 0 reaction 0 người được giao Xem trên GitHub
docs/improvement
Ngôn ngữ chính
Ruby
Star
39.5k
Fork
2.6k
Merge trung bình
4 ngày 32 phút
Pull request đã merge (30 ngày)
13

Mô tả

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)

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Đánh giá

Issue này chưa được đánh giá.

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.