| Name | docwalker JSON |
| Version |
1.0.2
JSON |
| download |
| home_page | |
| Summary | Quickly view documentation in source code in a language-agnostic way. |
| upload_time | 2023-07-18 04:45:32 |
| maintainer | |
| docs_url | None |
| author | Conner Marzen |
| requires_python | >=3.7,<4.0 |
| license | MIT |
| keywords |
tui
documentation
viewer
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# docwalker
[](https://badge.fury.io/py/docwalker)
Quickly view documentation in source code in a language-agnostic way.
Docwalker processes custom characters in both inline and block comments to
quickly extract and present documentation comments in source code.
For completeness, docwalker will also open entire Markdown files.
## Installation
```shell
$> pip install docwalker
$> docwalker --help
# usage: docwalker [-h] [-f FILE] src_dir
# DocWalker is a quick documentation filter/viewer for examining source code
# documentation. By default, DocWalker creates a local config file, .dwconf, which
# hosts the project-specific configuration.
# positional arguments:
# src_dir The source directory to examine.
# options:
# -h, --help show this help message and exit
# -f FILE, --file FILE The config file to reference for custom parsing [default: '<src_dir>/.dwconf']
```
## Usage
```shell
$> docwalker . # walks the current working directory.
```
## Configuration
### Default
The default configuration supports Python-esque syntax:
```ini
[parser.inline]
syntax = #@
[parser.block]
syntax_start = """@
syntax_end = @"""
[parser.listing]
syntax_start = #<<
syntax_end = #>>
```
* **inline:** `#@ inline documentation here`
* **block:** `"""@ block documentation here @"""`
* **listings:** `#<< code goes here #>>`
When `docwalker` first runs in a directory, a config file by the name `.dwconf`
is generated with these default values. Simply edit this file to change what
characters should be processed.
Raw data
{
"_id": null,
"home_page": "",
"name": "docwalker",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7,<4.0",
"maintainer_email": "",
"keywords": "tui,documentation,viewer",
"author": "Conner Marzen",
"author_email": "connermarzen@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/29/08/ef84ccfb5504a8f683f0b83716488646290cd7547f225264c1b3bfc67f69/docwalker-1.0.2.tar.gz",
"platform": null,
"description": "\n\n# docwalker\n\n[](https://badge.fury.io/py/docwalker)\n\nQuickly view documentation in source code in a language-agnostic way.\n\nDocwalker processes custom characters in both inline and block comments to\nquickly extract and present documentation comments in source code.\n\nFor completeness, docwalker will also open entire Markdown files.\n\n## Installation\n\n```shell\n$> pip install docwalker\n\n$> docwalker --help\n# usage: docwalker [-h] [-f FILE] src_dir\n\n# DocWalker is a quick documentation filter/viewer for examining source code\n# documentation. By default, DocWalker creates a local config file, .dwconf, which\n# hosts the project-specific configuration.\n\n# positional arguments:\n# src_dir The source directory to examine.\n\n# options:\n# -h, --help show this help message and exit\n# -f FILE, --file FILE The config file to reference for custom parsing [default: '<src_dir>/.dwconf']\n```\n\n## Usage\n\n```shell\n$> docwalker . # walks the current working directory.\n```\n\n## Configuration\n\n### Default\n\nThe default configuration supports Python-esque syntax:\n\n```ini\n[parser.inline]\nsyntax = #@\n\n[parser.block]\nsyntax_start = \"\"\"@\nsyntax_end = @\"\"\"\n\n[parser.listing]\nsyntax_start = #<<\nsyntax_end = #>>\n```\n\n* **inline:** `#@ inline documentation here`\n* **block:** `\"\"\"@ block documentation here @\"\"\"`\n* **listings:** `#<< code goes here #>>`\n\nWhen `docwalker` first runs in a directory, a config file by the name `.dwconf`\nis generated with these default values. Simply edit this file to change what\ncharacters should be processed.",
"bugtrack_url": null,
"license": "MIT",
"summary": "Quickly view documentation in source code in a language-agnostic way.",
"version": "1.0.2",
"project_urls": null,
"split_keywords": [
"tui",
"documentation",
"viewer"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "87f94a5d66e41d241f3d63a8bb438abec890f3914d3fd2f61c0c1d4ca06336e7",
"md5": "e606d2ab73b2b69e9944f4094679a9a5",
"sha256": "f5d2fd83d528b12fe9d8c59e1f44a5abf35dd5ea57f84fde96fc61d124cab132"
},
"downloads": -1,
"filename": "docwalker-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e606d2ab73b2b69e9944f4094679a9a5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7,<4.0",
"size": 6411,
"upload_time": "2023-07-18T04:45:31",
"upload_time_iso_8601": "2023-07-18T04:45:31.602168Z",
"url": "https://files.pythonhosted.org/packages/87/f9/4a5d66e41d241f3d63a8bb438abec890f3914d3fd2f61c0c1d4ca06336e7/docwalker-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2908ef84ccfb5504a8f683f0b83716488646290cd7547f225264c1b3bfc67f69",
"md5": "a331e8c1a2d4deae2a2de386a44eefc5",
"sha256": "2f66dcb9a20e7d1df7f3b769f6174a921c84e5f6d5e7873c2a2d958335fc3e0e"
},
"downloads": -1,
"filename": "docwalker-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "a331e8c1a2d4deae2a2de386a44eefc5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7,<4.0",
"size": 5000,
"upload_time": "2023-07-18T04:45:32",
"upload_time_iso_8601": "2023-07-18T04:45:32.553018Z",
"url": "https://files.pythonhosted.org/packages/29/08/ef84ccfb5504a8f683f0b83716488646290cd7547f225264c1b3bfc67f69/docwalker-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-18 04:45:32",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "docwalker"
}
