diff --git a/Pipfile.lock b/Pipfile.lock index b8f8473..8ec043d 100644 --- a/Pipfile.lock +++ b/Pipfile.lock @@ -558,11 +558,11 @@ }, "twine": { "hashes": [ - "sha256:2f6942ec2a17417e19d2dd372fc4faa424c87ee9ce49b4e20c427eb00a0f3f41", - "sha256:fcffa8fc37e8083a5be0728371f299598870ee1eccc94e9a25cef7b1dcfa8297" + "sha256:101f1c43ea4587ab19261d09157c63b6f37a0e55b215f0dd26304df1d49b620c", + "sha256:d12a873ab5db3e21f3fd393a82776401cc43a4966677466088abcb796aefafe2" ], "markers": "python_version >= '3.6'", - "version": "==3.3.0" + "version": "==3.4.0" }, "typed-ast": { "hashes": [ @@ -617,11 +617,11 @@ }, "urllib3": { "hashes": [ - "sha256:1b465e494e3e0d8939b50680403e3aedaa2bc434b7d5af64dfd3c958d7f5ae80", - "sha256:de3eedaad74a2683334e282005cd8d7f22f4d55fa690a2a1020a416cb0a47e73" + "sha256:2f4da4594db7e1e110a944bb1b551fdf4e6c136ad42e4234131391e21eb5b0df", + "sha256:e7b021f7241115872f92f43c6508082facffbd1c048e3c6e2bb9c2a157e28937" ], "markers": "python_version >= '2.7' and python_version not in '3.0, 3.1, 3.2, 3.3, 3.4' and python_version < '4'", - "version": "==1.26.3" + "version": "==1.26.4" }, "webencodings": { "hashes": [ diff --git a/docs/lazydocs.generation.md b/docs/lazydocs.generation.md index a486ced..b52504f 100644 --- a/docs/lazydocs.generation.md +++ b/docs/lazydocs.generation.md @@ -37,7 +37,7 @@ Creates an API docs file from a provided text. --- - + ## function `generate_docs` @@ -48,7 +48,7 @@ generate_docs( src_root_path: Optional[str] = None, src_base_url: Optional[str] = None, remove_package_prefix: bool = False, - ignored_modules: List[str] = [], + ignored_modules: Optional[List[str]] = None, overview_file: Optional[str] = None, watermark: bool = True, validate: bool = False @@ -74,12 +74,12 @@ Generates markdown documentation for provided paths based on Google-style docstr --- - + ## class `MarkdownGenerator` Markdown generator class. - + ### method `__init__` @@ -106,7 +106,7 @@ Initializes the markdown API generator. --- - + ### method `class2md` @@ -131,7 +131,7 @@ Takes a class and creates markdown text to document its methods and variables. --- - + ### method `func2md` @@ -157,7 +157,7 @@ Takes a function (or method) and generates markdown docs. --- - + ### method `import2md` @@ -182,7 +182,7 @@ Generates markdown documentation for a selected object/import. --- - + ### method `module2md` @@ -207,7 +207,7 @@ Takes an imported module object and create a Markdown string containing function --- - + ### method `overview2md` diff --git a/src/lazydocs/_about.py b/src/lazydocs/_about.py index d1056ff..6d06cce 100644 --- a/src/lazydocs/_about.py +++ b/src/lazydocs/_about.py @@ -1,5 +1,5 @@ """Information about this library. This file will automatically changed.""" -__version__ = "0.4.4" +__version__ = "0.4.6" # __author__ # __email__