温馨提示:本文翻译自stackoverflow.com，查看原文请点击：magento - Code Formatting for the ReadTheDocs System
magento python-sphinx read-the-docs mkdocs

magento - ReadTheDocs系统的代码格式

发布于 2020-03-27 11:42:31

我是第一次使用“ 阅读文档 ”。我正在为命令行系统编写文档，而我的“代码示例”包括shell输出的日志。Shell输出最终看起来像这样

读取文档的shell输出图像想格式化，就好像它是源代码一样，导致了一些奇怪的选择

就是说-服务（或我对它的使用？）正在尝试格式化运行shell命令的示例，就好像它是源代码一样，并且正在将其magento2:generate视为类常量。

我可以控制哪些代码块在阅读文档时获取源代码格式吗？我试过在管理员中未设置任何基本语言，但似乎没有效果。还是我需要在Sphinx级别的mkdocs上控制这些东西？（通过将markdown或sphinx文件转换为漂亮的HTML文件来阅读文档，可以看到其他内容吗？还是我不走运？

查看更多

查看更多

提问者
Alan Storm
被浏览
53
分享
Waylan 2019-07-10 02:28

您需要在源文档中定义代码块的“语言”。Sphinx和MkDocs都将尝试猜测该语言，这通常已经足够好了。但是，有时它会猜错并导致奇怪的突出显示。为了避免这种情况，这两种实现都提供了一种机制来手动定义每个代码块的语言。

狮身人面像

对于Sphinx，可以使用code-block指令并包括该块的“语言”：

.. code-block:: console

    You shell commands go here

在上面的示例中，我使用console了shell会话。别名shell-session也可以使用。需要注意的是替代词法分析器bash（和它的别名：sh，ksh，zsh，和shell），因为它们是一个shell脚本woudl不严格是合适的，而你在一个shell会话同时显示的命令和theoutput。

在Pygments文档中可以找到受支持的语言代码的完整列表。

MkDocs

MkDocs利用Fenced 代码块 Markdown扩展来定义代码块的“语言”：

``` shell
Your shell commands go here
```

作为MkDocs使用highlight.js而非Pygments来做，支持的语言列表是不同的。因此，我shell在上面的示例中使用了（用于shell会话）。

最新帖子

1
如何设置scrapy 最大redirect重定向次数
2
前端的同学，现在小程序用啥框架好?
3
并行用了两年的 macos 和 win10，感觉还是 win 生产力高，大家有同感吗？
4
公司自己研发一套 UI 框架，这样的公司多吗？各位程序员使用感受如何？
5
为什么编程语言不能提供一种基础的'decimal'类型"？
6
fastdfs 在CentOS-7-x86_64-DVD-2009.iso，编译libfastcommon-1.0.48，报错如上图。使用有影响吗?
7
为啥paddleseg预测的图片有100多张，可是得到的预测后的数据却少于100?
8
要不要等 m2 芯片，好焦虑~~~
9
长沙小公司面到 9k，去深圳能拿多少？
10
有哪些效率工具极大地提高了你的开发效率

最新文章

1
Golang | Gjson库 的使用简介
2
centos7 如何通过yum 安装python3 和 pip3
3
git 如何推送现有文件夹到远程仓库
4
如何使用docker-compose 运行迅搜(Xunsearch)
5
使用树莓派4b 搭建ddns 自动解析本地ip到阿里云域名
6
解决：Failed connect to raw.githubusercontent.com:443； 拒绝连接
7
php 各种编码统一转成utf-8
8
如何通过docker-compose 运行 python 程序
9
minio 如何添加用户和设置权限
10
liunx(centos) 安装 MinIO Client (mc) 及配置minio服务

相关问题

1
Magento：根据客户群获取产品价格
2
取消订单后重置库存状态
3
贷项通知单“返回库存”不更新库存可用性
4
通过数据库查询（EAV）获取产品报告
5
Python Selenium：未正确验证Block-Title。
6
安装magento 2不会部署/ pub / static / frontend和backend
7
Magento 2.3.4在我的本地主机中无法正常工作
8
magento 2中的重写模板
9
从其他jsTree实例保护jsTree样式
10
如何在magento 2.0中添加/插入扩展？