https://github.com/Ryanb58/tdoc

Python documentation generator.
https://github.com/Ryanb58/tdoc

Last synced: 13 days ago
JSON representation

Python documentation generator.

• Host: GitHub
• URL: https://github.com/Ryanb58/tdoc
• Owner: Ryanb58
• License: mit
• Archived: true
• Created: 2017-03-05T03:20:20.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-06-14T14:25:20.000Z (over 7 years ago)
• Last Synced: 2024-09-18T05:25:39.649Z (about 2 months ago)
• Language: Python
• Size: 206 KB
• Stars: 7
• Watchers: 4
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# TDoc

A python documentation generator.

### Installation

```

pip install tdoc

```

[https://pypi.python.org/pypi/tdoc](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 .

```