# doc2mds

**Repository Path**: gao_hyp_xyj_admin/doc2mds

## Basic Information

- **Project Name**: doc2mds
- **Description**: doc2mds: Convert docstring to markdown files
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-01-12
- **Last Updated**: 2024-06-08

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# doc2mds

doc2mds: Convert docstring to markdown files

This is a tool to convert docstrings of a file to markdown files.

An example is the [documents for Xponge](https://spongemm.cn/文档/Xponge文档/Xponge)

Another example is doc2mds [itself](https://gitee.com/gao_hyp_xyj_admin/doc2mds.git)

Usage:
```python
cd /your/package/parent/folder
mkdir _doc
cd _doc
python -m doc2mds package_name _doc
```