Skip to main content

# TDoc A python documentation generator.

### Installation

` pip install tdoc ` [pypi](https://pypi.python.org/pypi/tdoc)

### Generate the markdown documentation.

` tdoc generate --folder ./testfiles `

### Run a local webserver to view your documentation.

` tdoc serve `

### Non Auto Generated Docs:

To include custom markdown files simply create a folder called default_docs and place any and all markdown files inside of it. This directory will be copied over into the docs folder before any auto generation.

### Screenshot of Results using the Material Theme:

![Screen Shot](imgs/screenshot.png?raw=true “Screen Shot”)

### Installing As Editable:

` pip install --editable . `

Metadata

Release files for tdoc 0.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Built distribution (wheel)

Table of built distributions (wheels) for tdoc 0.2
File Interpreter ABI Platform
tdoc-0.2-py2.py3-none-any.whl Python 3, Python 2 none any Details

Release files / tdoc-0.2-py2.py3-none-any.whl

Download URL tdoc-0.2-py2.py3-none-any.whl
Size 4.4 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
d6cc222de3515c2b08ba53f33c9f61805b2d32925ca61f922153b143a41bd119
BLAKE2b-256 checksum
How to use checksums
22406c8f6e7c8e5b1f22b4847d313fc8c2ab6114c63e9b8885f3aa99cf27607c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.2 This release

1 release file

0.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page