DocWorker

docworker is a hobby project that grew out of a collection of personal scripts written to solve documentation-related problems. Over time, those scripts evolved into reusable utilities for working with documentation.

The project currently includes tools for serving Markdown content as HTML and generating documentation PDFs from source code. Additional functionality may be added as new needs arise.

The Emperor protects...

Features

Markdown Server: mkserver

A lightweight server for rendering Markdown files as HTML.

Capabilities:

• Serve Markdown documents through a web interface
• Render Markdown as HTML
• Preview documentation locally
• Simple setup and usage

Documentation PDF Generator: printerx

Generate documentation PDFs directly from source code projects.

Capabilities:

• Extract documentation from source code
• Generate PDF documentation
• Create portable documentation artifacts
• Support automated documentation workflows

Installation

pip install docworker

Install the required dependencies for the utilities you intend to use.

Usage

Run the Markdown Server

docworker wkserver --dirs <source-directory>

Generate Documentation PDF

docworker printerx --dirs <source-directory>

Project Structure

src/
|__docworker/
    ├── mkserver/
    ├── printerx/
    └── ...

Future Plans

DocWorker is developed incrementally based on personal needs and experimentation. Future additions may include:

• Additional documentation utilities
• More export formats
• Improved customization options
• Better source code analysis
• Automation and workflow integrations

Contributing

Contributions, bug reports, and suggestions are welcome. Feel free to open an issue or submit a pull request.

Status

This is a personal hobby project under active development. Features, interfaces, and behavior may change over time.

License

See the LICENSE file for details.