Metadata-Version: 2.1
Name: doc2mds
Version: 1.0
Summary: doc2mds: Convert docstring to markdown files
Author-email: Yijie Xia <yijiexia@pku.edu.cn>
License: ##############################################################################
        # NOTICE TO LICENSEE:
        #
        # Licensed under the Apache License, Version 2.0 (the "License");
        # you may not use this file except in compliance with the License.
        # You may obtain a copy of the License at
        # http://www.apache.org/licenses/LICENSE-2.0
        # Unless required by applicable law or agreed to in writing, software
        # distributed under the License is distributed on an "AS IS" BASIS,
        # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
        # See the License for the specific language governing permissions and
        # limitations under the License.
        ##############################################################################
Keywords: docstring,markdown
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: POSIX :: Linux
Classifier: Operating System :: Microsoft :: Windows
Description-Content-Type: text/markdown
License-File: LICENSE

# 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
```
