# PyMyDoc

**Repository Path**: XBCoder/py-my-doc

## Basic Information

- **Project Name**: PyMyDoc
- **Description**: 一个自动生成文档的小项目
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2022-04-14
- **Last Updated**: 2022-04-16

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# PyMyDoc

## 介绍
一个自动生成文档的小项目

## 软件架构
```python
def func_doc(func):  # 函数装饰器，用于装饰在需要生成文档的函数上

class ClassDoc(type):  # 元类，挂载到需要生成文档的类上

```

### 文档树
```python
_doc_tree = {}
'''
目前规定一下文档树的规范：
_doc_tree = {
    'module_A': {
        'sub': { sub_doc_tree },  # 子模块文档树
        'functions': ['直接隶属于该模块的函数列表的文档信息'],
        'class': ['直接隶属于该模块的 类 列表的文档信息']
    },
    ...
}
'''
```

### 如何进入开发者模式
`python setup.py develop`

之后可直接在其他代码处`import`