用于在栅格布局中创建面板的sphinx扩展。
sphinx-panels的Python项目详细描述
狮身人面像面板
一个sphinx扩展,用于创建为HTML+CSS优化的文档组件。在
- 在
在panels
指令使用引导程序4grid system和cards layout,在网格布局中创建内容面板。在 - 在
在link-button
指令创建一个可单击的按钮,链接到URL或引用,还可用于使整个面板可单击。在 - 在
在dropdown
指令创建可切换的内容。在 - 在
在tabbed
指令创建选项卡式内容。在 - 在
在opticon
和fa
(fontawesome)角色允许添加内联图标。在
..panels:: Content of the top-left panel --- Content of the top-right panel --- Content of the bottom-left panel --- Content of the bottom-right panel
link-button
指令可用于创建链接到URL(默认)或引用的按钮。
它们可以按Bootstrap button classes设置样式:
dropdown
指令组合了一个Bootstrap card
使用HTML details tag创建可折叠的
下拉面板。在
..dropdown:: Click on me to see my content! I'm the content which can be anything: ..link-button:: https://example.com :text: Like a Button :classes: btn-primary
发展
要运行测试:
pip install toxtox -e py37-sphinx3
要测试生成文档:
tox -e docs-clean htmltox -e docs-rebuild html
对于文档的实时生成:
tox -e docs-live html
你也可以在一个不同的主题中建立一个
export HTML_THEME=sphinx_book_themetox -e docs-live
对于代码样式和SCSS->;CSS更新:
pip install pre-commitpre-commit run --all
- 项目
标签: