freeCodeCamp / freeCodeCamp/devdocs

Fix header formatting in Sphinx-based docs

オープン
#1,154 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る
docs/improvement
主要言語
Ruby
スター
39.5k
フォーク
2.6k
平均マージ
4日 32分
マージ済み PR(30日)
13

説明

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)

コントリビューションガイド

コントリビューションガイドを開く

評価

この issue はまだ評価されていません。

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。