用于在栅格布局中创建面板的sphinx扩展。

sphinx-panels的Python项目详细描述


狮身人面像面板

Doc StatusCode style: blackPyPI

一个sphinx扩展,用于创建为HTML+CSS优化的文档组件。在

  • panels指令使用引导程序4grid systemcards layout,在网格布局中创建内容面板。在

  • link-button指令创建一个可单击的按钮,链接到URL或引用,还可用于使整个面板可单击。在

  • dropdown指令创建可切换的内容。在

  • tabbed指令创建选项卡式内容。在

  • opticonfa(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设置样式:

^{pr2}$

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

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
安卓为什么Java AudioEffect不支持双簧管?   增加内存后出现java IntelliJ堆大小错误   在unix/linux中工作的java中将unicode字符串转换为ASCII   java是否缺少正确对齐输出的值?   java Spring 3 MVC:动态表单中的onetomany(创建/更新时添加/删除)   java在接口中创建两个通用参数   lambda使用Java 8从嵌套列表中使用forEach查找项的替代方法是什么?   Java正则表达式匹配10位电话号码,中间有空格   linux将log4j外部化。使用命令行Java的属性文件   带有SSL的java简单RMI服务器   java无法为事务[…]打开JPA EntityManager无法获取驱动程序类“null”和URL“null”的连接   Android设备上的java Oauth Foursquare   for循环的ImageButton名称的java骰子模拟浓缩   java有没有简单的1d条形码阅读器?   如何在调用resultset后解决“无效字符串或缓冲区长度”。从java到访问mdb的getString()连接   在Java8中,是否可以使用JVM参数来控制何时(或在什么条件下)卸载类?