Pdoc

poetry | pdoc ¶

- uses: jambazid/gha-actions/python/poetry/pdoc@unknown
  with:
    working-directory: (1)
    package-namespace: (2)

Python project location (path to the pyproject.toml folder).
Package namespace.

Generates Python package documentation via pdoc.

Important

Assumes the following Project folder structure:

${working-directory}
├── pyproject.toml
├── ...
|
├── /src
|   └── /${namespace}
|       └── /${component}
|           └── ...
|
└── /tests
    └── ...

Inputs: ¤

Name	Description
`working-directory` ¤	Python project location (path to the `pyproject.toml` folder).
`package-namespace` ¤	Package namespace.
`project-summary` ¤	A brief summary of the project for display in the live docs footer.
`logo-url` ¤	URL or path to an icon to display as the package logo.
`favicon-url` ¤	URL or path to a favicon to display in live documentation.