alexandrekempf/automacdoc

Automatic generation of documentation for mkdocs

automacdoc's Issues

Example doesn't work

Hi there, I just made a fresh clone of the repository, changed directory into it and ran the example command automacdoc example/src example but get the error:

Traceback (most recent call last): File "c:\users\ca051\appdata\local\programs\python\python38\lib\runpy.py", line 192, in _run_module_as_main return _run_code(code, main_globals, None, File "c:\users\ca051\appdata\local\programs\python\python38\lib\runpy.py", line 85, in _run_code exec(code, run_globals) File "C:\Users\ca051\AppData\Local\Programs\Python\Python38\Scripts\automacdoc.exe\__main__.py", line 9, in <module> File "c:\users\ca051\appdata\local\programs\python\python38\lib\site-packages\automacdoc\main.py", line 11, in main write_doc(argv[1], argv[2]) File "c:\users\ca051\appdata\local\programs\python\python38\lib\site-packages\automacdoc\automacdoc.py", line 324, in write_doc write_module(root_path, module_name, mdfile_path) File "c:\users\ca051\appdata\local\programs\python\python38\lib\site-packages\automacdoc\automacdoc.py", line 207, in write_module module = importlib.import_module(module_import, package=module_import.split(".")[0]) File "c:\users\ca051\appdata\local\programs\python\python38\lib\importlib\__init__.py", line 127, in import_module return _bootstrap._gcd_import(name[level:], package, level) File "<frozen importlib._bootstrap>", line 1014, in _gcd_import File "<frozen importlib._bootstrap>", line 991, in _find_and_load File "<frozen importlib._bootstrap>", line 973, in _find_and_load_unlocked ModuleNotFoundError: No module named 'src\\class_and_function'

Any clues on what the issue is and how to fix it?

IndexError: list assignment index out of range

command: automacdoc . ./../wiki

Traceback (most recent call last):
File ".../env/bin/automacdoc", line 11, in
sys.exit(main())
File ".../env/lib/python3.6/site-packages/automacdoc/main.py", line 11, in main
write_doc(argv[1], argv[2])
File ".../env/lib/python3.6/site-packages/automacdoc/automacdoc.py", line 324, in write_doc
write_module(root_path, module_name, mdfile_path)
File ".../env/lib/python3.6/site-packages/automacdoc/automacdoc.py", line 211, in write_module
for n, o in inspect.getmembers(module, inspect.isclass)
File ".../env/lib/python3.6/site-packages/automacdoc/automacdoc.py", line 211, in
for n, o in inspect.getmembers(module, inspect.isclass)
File ".../env/lib/python3.6/site-packages/automacdoc/automacdoc.py", line 93, in create_class
clas["source"] = rm_docstring_from_source(inspect.getsource(obj))
File ".../env/lib/python3.6/site-packages/automacdoc/automacdoc.py", line 20, in rm_docstring_from_source
del source[1] # remove docstring
IndexError: list assignment index out of range

ModuleNotFoundError: No module named 'src.module'

Traceback (most recent call last):
File ".../env/bin/automacdoc", line 11, in
sys.exit(main())
File ".../env/lib/python3.6/site-packages/automacdoc/main.py", line 11, in main
write_doc(argv[1], argv[2])
File ".../env/lib/python3.6/site-packages/automacdoc/automacdoc.py", line 324, in write_doc
write_module(root_path, module_name, mdfile_path)
File ".../env/lib/python3.6/site-packages/automacdoc/automacdoc.py", line 207, in write_module
module = importlib.import_module(module_import, package=module_import.split(".")[0])
File ".../env/lib/python3.6/importlib/init.py", line 126, in import_module
return _bootstrap._gcd_import(name[level:], package, level)
File "", line 978, in _gcd_import
File "", line 961, in _find_and_load
File "", line 948, in _find_and_load_unlocked
ModuleNotFoundError: No module named 'src.module'

Add a `--help` option

ERROR - Config value: 'site_name'. Error: Required configuration not provided.

while running simple automacdoc command this output comes.

ERROR - Config value: 'site_name'. Error: Required configuration not provided.

Aborted with 1 Configuration Errors!
INFO - Building documentation...
ERROR - Config value: 'site_name'. Error: Required configuration not provided.

Aborted with 1 Configuration Errors!