Quickly view documentation in source code in a language-agnostic way.
Project description
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
$> 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
$> docwalker . # walks the current working directory.
Configuration
Default
The default configuration supports Python-esque syntax:
[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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
docwalker-1.0.2.tar.gz
(5.0 kB
view hashes)
Built Distribution
Close
Hashes for docwalker-1.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f5d2fd83d528b12fe9d8c59e1f44a5abf35dd5ea57f84fde96fc61d124cab132 |
|
MD5 | e606d2ab73b2b69e9944f4094679a9a5 |
|
BLAKE2b-256 | 87f94a5d66e41d241f3d63a8bb438abec890f3914d3fd2f61c0c1d4ca06336e7 |