doc2mds

Name	doc2mds JSON
Version	1.0 JSON
	download
home_page
Summary	doc2mds: Convert docstring to markdown files
upload_time	2024-01-12 15:22:19
maintainer
docs_url	None
author
requires_python
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
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

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

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "doc2mds",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "docstring,markdown",
    "author": "",
    "author_email": "Yijie Xia <yijiexia@pku.edu.cn>",
    "download_url": "https://files.pythonhosted.org/packages/e2/87/67ba1b608a2cca4f1c5511c44e8724009473aae36a058b6af2a2e752b138/doc2mds-1.0.tar.gz",
    "platform": null,
    "description": "# doc2mds\r\n\r\ndoc2mds: Convert docstring to markdown files\r\n\r\nThis is a tool to convert docstrings of a file to markdown files.\r\n\r\nAn example is the [documents for Xponge](https://spongemm.cn/\u6587\u6863/Xponge\u6587\u6863/Xponge)\r\n\r\nAnother example is doc2mds [itself](https://gitee.com/gao_hyp_xyj_admin/doc2mds.git)\r\n\r\nUsage:\r\n```python\r\ncd /your/package/parent/folder\r\nmkdir _doc\r\ncd _doc\r\npython -m doc2mds package_name _doc\r\n```\r\n",
    "bugtrack_url": null,
    "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. ##############################################################################",
    "summary": "doc2mds: Convert docstring to markdown files",
    "version": "1.0",
    "project_urls": null,
    "split_keywords": [
        "docstring",
        "markdown"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "e28767ba1b608a2cca4f1c5511c44e8724009473aae36a058b6af2a2e752b138",
                "md5": "933fc40b80ddc8b1b99a27a662f6ac0a",
                "sha256": "45ba9cc992c0fc12bddad354e5325596b30682b296937570222912872310fcc0"
            },
            "downloads": -1,
            "filename": "doc2mds-1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "933fc40b80ddc8b1b99a27a662f6ac0a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 3832,
            "upload_time": "2024-01-12T15:22:19",
            "upload_time_iso_8601": "2024-01-12T15:22:19.616974Z",
            "url": "https://files.pythonhosted.org/packages/e2/87/67ba1b608a2cca4f1c5511c44e8724009473aae36a058b6af2a2e752b138/doc2mds-1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-01-12 15:22:19",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "doc2mds"
}