Python To Markdown Documentation Tool
Project description
# 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 . `
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 Distributions
Built Distribution
File details
Details for the file tdoc-0.2-py2.py3-none-any.whl
.
File metadata
- Download URL: tdoc-0.2-py2.py3-none-any.whl
- Upload date:
- Size: 4.4 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | d6cc222de3515c2b08ba53f33c9f61805b2d32925ca61f922153b143a41bd119 |
|
MD5 | 31aa031b1c9d5b28b491499c66001fea |
|
BLAKE2b-256 | 22406c8f6e7c8e5b1f22b4847d313fc8c2ab6114c63e9b8885f3aa99cf27607c |