lazydocs icon indicating copy to clipboard operation
lazydocs copied to clipboard

📖 Generate markdown API documentation from Google-style Python docstring. The lazy alternative to Sphinx.

Results 20 lazydocs issues
Sort by recently updated
recently updated
newest added

**Describe the bug:** While trying to run it against the python directory I am getting an import error for get_terminal_size. Is there any way to sort out this error. **Error...

bug

**Feature description:** Add an option to prefix source url with ".py" before \# (implementation possible at `src/lazydocs/generation.py: _get_src_path()`) and remove ".md" extensions from overview file. As such when correct base...

feature

Hey! I just came across an issue with the following environment: I'm on Windows 10 and my python files are placed on a network volume (R:\). Im calling lazydocs as...

bug

**Describe the bug:** When generating documentation the source badge creates non-compliant URLs. Specifically, when combining value provided by `-src-base-url` with the path, it seems to use the OS specific path...

bug

**Describe the bug:** When using the function "generate_docs", if there are two files with the same name under different subpackages, (e.g. subpkg1/utils.py and subpkg2/utils.py), the docs generated for the second...

bug

Hello, I have a structure like this: ``` foo `-- __init__.py `-- common.py `-- bar.py ``` where in `bar.py` I do `import foo.common`. When running lazydocs, I get the message...

bug

Hey, After installing `lazydocs` for Python `3.12` im getting this error: ``` lazydocs --overview-file README.md --src-base-url="https://github.com/xx/xx-xx/blob/main/" xx/xx Generating docs for python package at: internal_tools/internal_tools Failed to generate docs for module...

bug

Bumps [cryptography](https://github.com/pyca/cryptography) from 3.4.7 to 42.0.2. Changelog Sourced from cryptography's changelog. 42.0.2 - 2024-01-30 * Updated Windows, macOS, and Linux wheels to be compiled with OpenSSL 3.2.1. * Fixed an...

dependencies
stale

I see that no real changes were done in 2023 and 2022. So is lazydocs still maintained?

Building docs for modules that contain dataclasses fail with: `AttributeError("module '' has no attribute '__create_fn__'")` The __init__ representation from dataclasses is different than for normal classes.

bug