Add documentation on how to extend the theme · readthedocs/sphinx_rtd_theme#582

2018-02-27T18:56:51.000Z

This is something that I get questions on a lot: * New maintainers want to know how to add CSS/JS. We prescribe adding in a `setup()` extension point via `app.add_stylesheet()` to get around our extension * Companies doing a deeper conversion of our theme to match their brand should know how to extend our templates * Our template blocks should be documented some? Or at least we point to the Sphinx default list of blocks that we emulate

(3 comments) (2 reactions) (0 assignees)CSS (3,473 stars) (1,413 forks)batch import

Good First IssueNeeded: documentation

説明

This is something that I get questions on a lot:

New maintainers want to know how to add CSS/JS. We prescribe adding in a setup() extension point via app.add_stylesheet() to get around our extension
Companies doing a deeper conversion of our theme to match their brand should know how to extend our templates
Our template blocks should be documented some? Or at least we point to the Sphinx default list of blocks that we emulate

コントリビューターガイド

技術スタック: pythoncsshtmljavascript
領域: documentationfrontend
Issue 種別: documentation
難度: 3
推定時間: half day
活動状況: stale
明確さ: clear
前提条件: Sphinx basicsCSS/HTMLPython
初心者向け度: 70
調査方針: Review the theme's ` init .py` for the `setup()` function and how `app.add stylesheet()` is used. Examine the template files in `sphinx rtd theme/`, particularly `layout.html`, to understand the template block structure. Compare with Sphinx's default template blocks. The issue comments may provide additional context on what users commonly ask.