search

ml-tooling / lazydocs

📖 Generate markdown API documentation from Google-style Python docstring. The lazy alternative to Sphinx.
MIT License
197 stars 38 forks source link

Strange results when you have a setup.py in your package #43

Closed ronny-rentner closed 1 year ago

ronny-rentner commented 1 year ago

I run Python 3.10 on Debian 11:

lazydocs --output-path="./docs/lazydocs" --overview-file="README.md" --src-base-url="https://github.com/ronny-rentner/ultraimport/blob/main/" --no-watermark .
Generating docs for python package at: .
/usr/lib/python3/dist-packages/setuptools/config/pyprojecttoml.py:108: _BetaConfiguration: Support for `[tool.setuptools]` in `pyproject.toml` is still *beta*.
  warnings.warn(msg, _BetaConfiguration)
usage: lazydocs [global_opts] cmd1 [cmd1_opts] [cmd2 [cmd2_opts] ...]
   or: lazydocs --help [cmd1 cmd2 ...]
   or: lazydocs --help-commands
   or: lazydocs cmd --help

error: option --output-path not recognized

It works if I exclude setup.py:

lazydocs --output-path="./docs/lazydocs" --overview-file="README.md" --src-base-url="https://github.com/ronny-rentner/ultraimport/blob/main/" --no-watermark --ignored-modules="setup" .
Generating docs for python package at: .
Writing ultraimport.md.
Writing README.md.
Writing mkdocs .pages file.

Shouldn't setup.py be excluded automatically? What's the point in generating documentation for it?

github-actions[bot] commented 1 year ago

This issue is stale because it has been open 90 days with no activity. Remove stale label or comment or this will be closed in 14 days