📜  重构文本 | .rst 文件到 HTML 文件使用Python for Documentation

📅  最后修改于: 2022-05-13 01:54:26.059000             🧑  作者: Mango

重构文本 | .rst 文件到 HTML 文件使用Python for Documentation

.rst 文件(reStructuredText)简介:

reStructuredText是一种文本数据的文件格式,主要由基于Python的社区用于以类似于Java等其他工具的简单方式开发文档。大多数基于 Python 的软件和库的文档都是使用reStructuredText编写的,因此在为任何组织做出贡献时学习它很重要。

与Python一样,RST 语法对缩进也很敏感。

reStructuredText 的示例代码:
下面给出了一些基本语法和它们的 HTML 渲染。

usagesyntaxHTML rendering
Heading*****
Heading
*****

Heading

italic*italic*italic
bold**bold**bold
link`gfg`gfg
verbatim``Some text or code``

重组的.rst

Some text or code

使用.rst扩展名保存文件。

Python代码:

以下是将.rst文件转换为 HTML 文件的Python代码。 docutils是安装Python时下载的预定义库。 publish_file方法用于通过将文件名作为参数传递来将rst转换为 html。

******************************
This is example of rst on GFG
******************************
  
*GeeksforGeeks in italic*
  
**GeeksforGeeks in bold**
  
`Gfg website`
  
``GeeksforGeeks in vebatim``

输出.html
运行Python代码后,将在与 rst 文件相同的目录中创建一个 HTML 文件。由于 HTML 代码是自动生成的,因此 HTML 代码比人编写的普通 HTML 代码复杂。下图显示了上面显示的 reStructuredText 的 HTML 呈现。