error: option --overview-file not recognized

[SaschaWeisenberger]

Describe the bug:

I have a project with a python module.
When I execute lazydocs --overview-file="Overview.md" .\mymodule I get errors when I reference files within the same package:

Failed to generate docs for module XXX: ImportError('attempted relative import with no known parent package')

Then I tried to simply call lazydocs --overview-file="Overview.md" ., which works, but here I get the output:

Generating docs for python package at: .
Writing mymodule.XXX.md.
Writing mymodule.YYY.md.
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 --overview-file not recognized

This happens ONLY if there is a file README.md in the root directory. I renamed it to README2.md and everything worked fine.

Expected behaviour:

Markdown file outside the ./docs folder should be ignored.

Steps to reproduce the issue:
Call lazydocs --overview-file="xxx.md" . in a folder where a file named README.md exists.

Technical details:

• Windows 11
• Python 3.11.9
• lazydocs 0.4.8

Possible Fix:

Additional context:

[ltan10]

@SaschaWeisenberger can you try the latest build from the master branch from github and not from pypi i.e. "pip install lazydoc"? I believe this was an issue during module loading which was patched my PR but hasn't been released to pypi yet.

Feel free to ask if you need assistance with installing lazydoc via the github repo.

[ltan10]

Hi @SaschaWeisenberger apologies for my previous message, i jumped the gun. That was unrelated to your problem.

Since you are using lazydoc 0.4.8 and python 3.11. I assume you have implemented the find_module AttributeError fix.
I tried to see if i could replicate your issue specifically about having to rename a readme.md file that is in the same package, however i was not able to.

With regards to ImportError('attempted relative import with no known parent package'), based of your post, your modules are located in the top level of your package.
And based off your lazydoc cli used. You used the file directory option to parse your modules. As such the modules are loaded without any knowledge of their parent package as such relative imports do not work.

There are a couple of options to work around this. one of which you have found which is to go one directory level up.
Or try using pythonic package nomencalture lazydocs --overview-file="Overview.md" .mymodule note the missing \
Or you could put your package into your python path either by editable installs or sys.path and use the pythonic package and once again use the pythonic package method.

[ltan10]

@SaschaWeisenberger I believe i found workaround for modules containing top level imports.
Can you try the following forked branch of lazydocs and report back.
https://github.com/ltan10/lazydocs/tree/bugfix/module-loading-and-md-format

[github-actions]

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