编译Kedro Build-docs后，Kedro文档并未显示所有功能

发布于 2025-01-22 12:51:02 字数 778 浏览 1 评论 0原文

我尝试使用kedro build-docs命令来记录我的项目。

.
├── docs
└── src
    ├── setup.py
    ├── tests
    ├── <project>
    │   ├── __init__.py
    │   ├── __main__.py
    │   ├── __pycache__
    │   ├── a
    │   ├── hooks.py
    │   ├── pipeline_registry.py
    │   ├── pipelines
    │   │   └── pipeline.py
    │   ├── settings.py
    │   ├── b
    │   └── c
    |_

a，b和c是项目中的不同模块，我正在尝试使用sphinx进行文档。我在终端中编译了kedro build-docs命令，并在docs目录中生成.rst文件，并创建docs/build/build/* */index.html文件。打开此消息后，我发现所有的模块列为超链接，然后进入a模块后，我发现并非所有功能都记录在记录下。例如，如果我在模块中列出了3个功能a，则HTML仅显示2个功能，而REST则不会在HTML页面上显示。需要帮助以显示所有功能DOC字符串。

原文

I tried documenting my project using kedro build-docs command.

.
├── docs
└── src
    ├── setup.py
    ├── tests
    ├── <project>
    │   ├── __init__.py
    │   ├── __main__.py
    │   ├── __pycache__
    │   ├── a
    │   ├── hooks.py
    │   ├── pipeline_registry.py
    │   ├── pipelines
    │   │   └── pipeline.py
    │   ├── settings.py
    │   ├── b
    │   └── c
    |_

a, b and c are different modules inside project and I am trying to document using sphinx. I compiled kedro build-docs command in terminal and it generates .rst files inside the docs directory and creates docs/build/**/index.html file. Upon opening this I find all my modules listed as hyperlink, and upon going inside a module, I find not all functions were documented.
For example if I have 3 functions listed inside module a , the html shows up only 2 and rest are not shown up on html page.
Need help to show up all functions doc strings.