Kedro documentation does not show up all functions after compiling kedro build-docs

207 Views Asked by At

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.

0

There are 0 best solutions below