sphinx 字符串转html,在Pycharm中获取Sphinx，以将我的文档字符串包含在生成的html中...

也许您可以尝试以下方法：

确保要尝试记录的模块具有一个__init__.py文件，以便以后可以适当地导入它们。您的tools和modules目录需要__init__.py个文件。

确保您要记录的所有模块均已设置了正确的sphinx批注：

module_1.py：

"""

.. module:: module_1

:platform: Unix, Windows

:synopsis: A useful module indeed.

"""

def public_fn_with_sphinxy_docstring(name, state=None):

"""This function does something.

:param name: The name to use.

:type name: str.

:param state: Current state to be in.

:type state: bool.

:returns: int -- the return code.

:raises: AttributeError, KeyError

"""

return 0

创建一个新的.rst文件，可能称为code.rst，其中包括您要记录的模块。然后在您的.rst中引用这个新的index.rst文件：

code.rst：

Documentation for the Code

**************************

.. automodule:: an_example_pypi_project

module #1 -- auto members

=========================

This is something I want to say that is not in the docstring.

.. automodule:: an_example_pypi_project.module_1

:members:

index.rst：

.. toctree::

:maxdepth: 2

:caption: Contents:

# other rst files you're including in your sphinx docs

code.rst

这是一个非常不错的解释，如果您也想检查一下，请tutorial。希望有帮助！

sphinx 字符串转html,在Pycharm中获取Sphinx，以将我的文档字符串包含在生成的html中...相关推荐

java中openoffice_巧用Java读取OpenOffice文档
由于项目的需要,我们需要在Java程序读取OpenOffice文档,并对数据进行处理.本文介绍了如何使用ODF Toolkit去读取OpenOffice SpreadSheet的内容. 1. Open ...
python中的文档字符串(docString)
python中的文档字符串(docString) - 泥土 - 博客园 python中的文档字符串(docString) Posted on 2009-02-19 15:27 泥土阅读(2122) ...
python html 语法高亮,在Python中使用doxygen样式文档字符串的Vim语法高亮显示
我开始使用doxygen来生成我的Python代码的文档. 我使用doxypy过滤器来预处理Python文档字符串. 我的目标是在Python中有一个很好的语法突出显示doxygen注释. 在专用.d ...
python oop 继承_oop-在Python中继承方法的文档字符串
oop-在Python中继承方法的文档字符串我有一个带有文档字符串的OO层次结构,它需要与代码本身一样多的维护. 例如., class Swallow(object): def airspeed(s ...
Python文档字符串生成器：基于CodeBERT，支持Google、Numpy等多种输出格式
木易发自凹非寺量子位报道 | 公众号 QbitAI 又一款懒人神器问世了: Visual Studio Code的扩展,基于CodeBERT的Python文档字符串生成器. 看来现在,这群偷 ...
函数小知识点（文档字符串，闭包等）
1 文档字符串(Documentation Strings) 一般被称为docstring,一款你应当使用的重要工具,它能够帮助你更好地记录程序并让其更加易于理解.令人惊叹的是,当程序实际运行时,我们 ...
Python常用函数--文档字符串DocStrings
Python 有一个甚是优美的功能称作python文档字符串(Documentation Strings),在称呼它时通常会使用另一个短一些的名字docstrings.DocStrings 是一款你应 ...
这个VS Code扩展可以自动生成Python文档字符串
机器之心报道编辑:魔王该扩展利用可处理编程语言和自然语言的预训练模型 CodeBERT,实现快速生成 Python 文档字符串的功能. Visual Studio Code(简称 VS Code) ...
利用CodeBERT，这个VS Code扩展可以自动生成Python文档字符串
点击上方"AI遇见机器学习",选择"星标"公众号重磅干货,第一时间送达来自:机器之心该扩展利用可处理编程语言和自然语言的预训练模型 CodeBERT,实现 ...
vscode python 自动补全_利用CodeBERT，这个VS Code扩展可以自动生成Python文档字符串...
机器之心报道编辑:魔王该扩展利用可处理编程语言和自然语言的预训练模型 CodeBERT,实现快速生成 Python 文档字符串的功能. Visual Studio Code(简称 VS Code) ...

sphinx 字符串转html,在Pycharm中获取Sphinx，以将我的文档字符串包含在生成的html中...

sphinx 字符串转html,在Pycharm中获取Sphinx，以将我的文档字符串包含在生成的html中...相关推荐

最新文章

热门文章