# Documentation
- DocsGen is a Python library that generates documentation for Python libraries.
- Library Features:
- Generates documentation in markdown format.
- Simple to use.
- Automatic documentation generation.
- Supports creating examples for usage.
## Example to load the library
```python
from docsgen import *
```
## `DocsGen` (class)
---
### `DocsGen.__init__` (method)
**Description**: Constructor for DocsGen.
**Arguments**:
```txt
lib_name: str
directory_path: str
```
**Example for use**:
```python
docsgen = DocsGen(lib_name, directory_path)
```
---
### `DocsGen.write_documentation` (method)
**Description**: Method to write the documentation.
**Arguments**:
```txt
This function has no arguments.
```
**Returns**:
```txt
NoneType
```
**Returns Description**: Returns nothing.
**Example for use**:
```python
docsgen = DocsGen(lib_name, directory_path)
docsgen.write_documentation()
```
---
### Command Line Interface (CLI)
To use the library's CLI, execute the following command:
```
docsgen lib_name, dir
```
This command generates documentation for the specified library (`lib_name`) located in the specified directory (`dir`).
Raw data
{
"_id": null,
"home_page": "https://github.com/IceBytes/DocsGen/",
"name": "docsgen",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "Auto docs, Generate docs",
"author": "Just Ice",
"author_email": "MrAws.developer@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/dc/ff/fb549db61ba7ce2164800e9dacfdf0f0db7d1f4635275bd7b82937e9f047/docsgen-0.0.1.tar.gz",
"platform": null,
"description": "\n# Documentation\n\n- DocsGen is a Python library that generates documentation for Python libraries.\n\n- Library Features:\n - Generates documentation in markdown format.\n - Simple to use.\n - Automatic documentation generation.\n - Supports creating examples for usage.\n\n## Example to load the library\n\n```python\nfrom docsgen import *\n```\n\n\n## `DocsGen` (class)\n---\n\n### `DocsGen.__init__` (method)\n**Description**: Constructor for DocsGen.\n\n**Arguments**:\n```txt\nlib_name: str \ndirectory_path: str \n```\n\n**Example for use**:\n```python\ndocsgen = DocsGen(lib_name, directory_path)\n```\n\n---\n\n### `DocsGen.write_documentation` (method)\n**Description**: Method to write the documentation.\n\n**Arguments**:\n```txt\nThis function has no arguments.\n```\n\n**Returns**:\n```txt\nNoneType\n```\n**Returns Description**: Returns nothing.\n\n**Example for use**:\n```python\ndocsgen = DocsGen(lib_name, directory_path)\ndocsgen.write_documentation()\n```\n\n---\n\n### Command Line Interface (CLI)\nTo use the library's CLI, execute the following command:\n\n```\ndocsgen lib_name, dir\n```\n\nThis command generates documentation for the specified library (`lib_name`) located in the specified directory (`dir`).\n",
"bugtrack_url": null,
"license": null,
"summary": "DocsGen is a Python library that generates docs for python libs.",
"version": "0.0.1",
"project_urls": {
"Bug Reports": "https://github.com/IceBytes/DocsGen/issues",
"Documentation": "https://github.com/IceBytes/DocsGen/",
"Homepage": "https://github.com/IceBytes/DocsGen/",
"Source": "https://github.com/IceBytes/DocsGen/"
},
"split_keywords": [
"auto docs",
" generate docs"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ab62598562549cb35c4cc8422482cef1f633c96851b44e6f29f9ceffa320c88b",
"md5": "4713f7efa566797ccc66aef4ec03b5ec",
"sha256": "c62e355f74268e5660bbf1200c2945c9b6f4638a29ee71615e1ba25cd4a64e01"
},
"downloads": -1,
"filename": "docsgen-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4713f7efa566797ccc66aef4ec03b5ec",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4603,
"upload_time": "2024-06-07T10:26:01",
"upload_time_iso_8601": "2024-06-07T10:26:01.630590Z",
"url": "https://files.pythonhosted.org/packages/ab/62/598562549cb35c4cc8422482cef1f633c96851b44e6f29f9ceffa320c88b/docsgen-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "dcfffb549db61ba7ce2164800e9dacfdf0f0db7d1f4635275bd7b82937e9f047",
"md5": "5bfba8ac1807cb3350e8b08bcc5c37ca",
"sha256": "24589c630144f8e90e57a9eadbac35c23ad55624a3f1565c5e79abd754955f76"
},
"downloads": -1,
"filename": "docsgen-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "5bfba8ac1807cb3350e8b08bcc5c37ca",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4336,
"upload_time": "2024-06-07T10:26:04",
"upload_time_iso_8601": "2024-06-07T10:26:04.183471Z",
"url": "https://files.pythonhosted.org/packages/dc/ff/fb549db61ba7ce2164800e9dacfdf0f0db7d1f4635275bd7b82937e9f047/docsgen-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-06-07 10:26:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "IceBytes",
"github_project": "DocsGen",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "docsgen"
}
JSON
