## ``gen_doc`` - Library to generate documentation
### Installation
```commandline
pip install gen_doc
```
### What it does?
+ aggregates all `.py` files into one or multiple `.md` files, keeping the same hierarchy
+ collects all classes and methods with their information
+ parses `google` & `sphinx` py docstrings.
### How to use:
+ install the library
+ in your project directory open the terminal
+ run the command `gen_doc init`
+ adjust config file accordingly
+ run the command `gen_doc build -c`
### Details
#### General
```text
Usage: gen_doc [OPTIONS] COMMAND [ARGS]...
Utility for generating project documentation from docstrings
Options:
-v, --version Get library version
-i, --init Init gen_doc config with default parameters
-b, --build Build documentation by config
--help Show this message and exit.
Commands:
build Build documentation
init To init config file in order to generate documentation.
```
#### Init
```text
Usage: gen_doc init [OPTIONS]
To init config file in order to generate documentation.
Options:
-f, --file-config TEXT Config file name [default: gen_doc.yaml]
-o, --overwrite To overwrite, in case file already exists
--help Show this message and exit.
```
#### Build
```text
Usage: gen_doc build [OPTIONS] [[py]]
Build documentation
Options:
-sm, --save-mode [md] Save mode
-hi, --hierarchically Extract with the same hierarchy
-o, --overwrite To overwrite, in case file already exists
-p2r, --path-to-root TEXT Path to the directory for which documentation
should be compiled
-p2s, --path-to-save TEXT Path to the directory where the documentation
should be saved
-f2s, --file-to-save TEXT Path to the directory where the documentation
should be saved
-c, --config Use config to build documentation.
-f, --file-config TEXT Config file name [default: gen_doc.yaml]
--help Show this message and exit.
```
Raw data
{
"_id": null,
"home_page": "https://github.com/Shchusia/gendoc",
"name": "gen-doc",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "pip,gen_doc",
"author": "Denis Shchutkiy",
"author_email": "denisshchutskyi@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/00/38/8e050d4beb119d2a733c3500851fcb2a61eba058c71b3cc3c6397a6af3e7/gen_doc-0.1.4.tar.gz",
"platform": null,
"description": "## ``gen_doc`` - Library to generate documentation\n\n### Installation\n\n```commandline\npip install gen_doc\n```\n\n### What it does?\n+ aggregates all `.py` files into one or multiple `.md` files, keeping the same hierarchy\n+ collects all classes and methods with their information\n+ parses `google` & `sphinx` py docstrings.\n\n### How to use:\n\n+ install the library\n+ in your project directory open the terminal\n+ run the command `gen_doc init`\n+ adjust config file accordingly\n+ run the command `gen_doc build -c`\n\n### Details\n\n#### General\n```text\nUsage: gen_doc [OPTIONS] COMMAND [ARGS]...\n\n Utility for generating project documentation from docstrings\n\nOptions:\n -v, --version Get library version\n -i, --init Init gen_doc config with default parameters\n -b, --build Build documentation by config\n --help Show this message and exit.\n\nCommands:\n build Build documentation\n init To init config file in order to generate documentation.\n```\n#### Init\n```text\nUsage: gen_doc init [OPTIONS]\n To init config file in order to generate documentation.\nOptions:\n -f, --file-config TEXT Config file name [default: gen_doc.yaml]\n -o, --overwrite To overwrite, in case file already exists\n --help Show this message and exit.\n```\n#### Build\n```text\nUsage: gen_doc build [OPTIONS] [[py]]\n Build documentation\nOptions:\n -sm, --save-mode [md] Save mode\n -hi, --hierarchically Extract with the same hierarchy\n -o, --overwrite To overwrite, in case file already exists\n -p2r, --path-to-root TEXT Path to the directory for which documentation\n should be compiled\n -p2s, --path-to-save TEXT Path to the directory where the documentation\n should be saved\n -f2s, --file-to-save TEXT Path to the directory where the documentation\n should be saved\n -c, --config Use config to build documentation.\n -f, --file-config TEXT Config file name [default: gen_doc.yaml]\n --help Show this message and exit.\n```\n",
"bugtrack_url": null,
"license": "",
"summary": "Library to generate documentation",
"version": "0.1.4",
"split_keywords": [
"pip",
"gen_doc"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "00388e050d4beb119d2a733c3500851fcb2a61eba058c71b3cc3c6397a6af3e7",
"md5": "ccae12c197457cfd0cf0180e9c26a68d",
"sha256": "85de47e1ccaf474cbf306092e3b4dccf904290db1d5e0224b47fc1ca83543f75"
},
"downloads": -1,
"filename": "gen_doc-0.1.4.tar.gz",
"has_sig": false,
"md5_digest": "ccae12c197457cfd0cf0180e9c26a68d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 22826,
"upload_time": "2023-02-06T14:59:21",
"upload_time_iso_8601": "2023-02-06T14:59:21.126571Z",
"url": "https://files.pythonhosted.org/packages/00/38/8e050d4beb119d2a733c3500851fcb2a61eba058c71b3cc3c6397a6af3e7/gen_doc-0.1.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-06 14:59:21",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "Shchusia",
"github_project": "gendoc",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"tox": true,
"lcname": "gen-doc"
}
JSON
