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 评论) (2 反应) (0 负责人)CSS (3,473 star) (1,413 fork)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
议题类型: 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.