## mathy_pydoc
**IMPORTANT** This is a fork of the pydoc_markdown repo to use the legacy version for Mathy's simple API doc needs. See the official repo for the latest stable updates: https://github.com/NiklasRosenstein/pydoc-markdown
– _insipired by the [Keras] Documentation_
## Installation
pip install mathy_pydoc
## Usage
mathy_pydoc generates plain Markdown files from Python modules using the
`mathy_pydoc` command. Specify one or more module names on the command-line.
Supports the `+` syntax to include members of the module (or `++` to include
members of the members, etc.)
mathy_pydoc mypackage+ mypackage.mymodule+ > docs.md
## Syntax
### Cross-references
Symbols in the same namespace may be referenced by using a hash-symbol (`#`)
directly followed by the symbols' name, including relative references. Note that
using parentheses for function names is encouraged and will be ignored and
automatically added when converting docstrings. Examples: `#ClassName.member` or
`#mod.function()`.
For absolute references for modules or members in names that are not available
in the current global namespace, `#::mod.member` must be used (note the two
preceeding two double-colons).
For long reference names where only some part of the name should be displayed,
the syntax `#X~some.reference.name` can be used, where `X` is the number of
elements to keep. If `X` is omitted, it will be assumed 1. Example:
`#~some.reference.name` results in only `name` being displayed.
In order to append additional characters that are not included in the actual
reference name, another hash-symbol can be used, like `#Signal#s`.
### Sections
Sections can be generated with the Markdown `# <Title>` syntax. It is important
to add a whitespace after the hash-symbol (`#`), as otherwise it would represent
a cross-reference. Some special sections alter the rendered result of their
content, including
- Arguments (1)
- Parameters (1)
- Attributes (1)
- Members (1)
- Raises (2)
- Returns (2)
(1): Lines beginning with `<ident> [(<type>[, ...])]:` are treated as
argument/parameter or attribute/member declarations. Types listed inside the
parenthesis (optional) are cross-linked, if possible. For attribute/member
declarations, the identifier is typed in a monospace font.
(2): Lines beginning with `<type>[, ...]:` are treated as raise/return type
declarations and the type names are cross-linked, if possible.
Lines following a name's description are considered part of the most recent
documentation unless separated by another declaration or an empty line. `<type>`
placeholders can also be tuples in the form `(<type>[, ...])`.
### Code Blocks
GitHub-style Markdown code-blocks with language annotations can be used.
```python
>>> for i in range(100):
...
```
---
Raw data
{
"_id": null,
"home_page": "https://github.com/mathy/mathy_pydoc",
"name": "mathy-pydoc",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "markdown pydoc generator docs documentation",
"author": "Justin DuJardin",
"author_email": "justin@dujardinconsulting.com",
"download_url": "https://files.pythonhosted.org/packages/84/14/bf088e5c469ebf835c1e579cc33971e6524466520935b00be3295b545a41/mathy_pydoc-0.7.30.tar.gz",
"platform": null,
"description": "## mathy_pydoc\n\n**IMPORTANT** This is a fork of the pydoc_markdown repo to use the legacy version for Mathy's simple API doc needs. See the official repo for the latest stable updates: https://github.com/NiklasRosenstein/pydoc-markdown\n\n– _insipired by the [Keras] Documentation_\n\n## Installation\n\n pip install mathy_pydoc\n\n## Usage\n\nmathy_pydoc generates plain Markdown files from Python modules using the\n`mathy_pydoc` command. Specify one or more module names on the command-line.\nSupports the `+` syntax to include members of the module (or `++` to include\nmembers of the members, etc.)\n\n mathy_pydoc mypackage+ mypackage.mymodule+ > docs.md\n\n## Syntax\n\n### Cross-references\n\nSymbols in the same namespace may be referenced by using a hash-symbol (`#`)\ndirectly followed by the symbols' name, including relative references. Note that\nusing parentheses for function names is encouraged and will be ignored and\nautomatically added when converting docstrings. Examples: `#ClassName.member` or\n`#mod.function()`.\n\nFor absolute references for modules or members in names that are not available\nin the current global namespace, `#::mod.member` must be used (note the two\npreceeding two double-colons).\n\nFor long reference names where only some part of the name should be displayed,\nthe syntax `#X~some.reference.name` can be used, where `X` is the number of\nelements to keep. If `X` is omitted, it will be assumed 1. Example:\n`#~some.reference.name` results in only `name` being displayed.\n\nIn order to append additional characters that are not included in the actual\nreference name, another hash-symbol can be used, like `#Signal#s`.\n\n### Sections\n\nSections can be generated with the Markdown `# <Title>` syntax. It is important\nto add a whitespace after the hash-symbol (`#`), as otherwise it would represent\na cross-reference. Some special sections alter the rendered result of their\ncontent, including\n\n- Arguments (1)\n- Parameters (1)\n- Attributes (1)\n- Members (1)\n- Raises (2)\n- Returns (2)\n\n(1): Lines beginning with `<ident> [(<type>[, ...])]:` are treated as\nargument/parameter or attribute/member declarations. Types listed inside the\nparenthesis (optional) are cross-linked, if possible. For attribute/member\ndeclarations, the identifier is typed in a monospace font.\n\n(2): Lines beginning with `<type>[, ...]:` are treated as raise/return type\ndeclarations and the type names are cross-linked, if possible.\n\nLines following a name's description are considered part of the most recent\ndocumentation unless separated by another declaration or an empty line. `<type>`\nplaceholders can also be tuples in the form `(<type>[, ...])`.\n\n### Code Blocks\n\nGitHub-style Markdown code-blocks with language annotations can be used.\n\n ```python\n >>> for i in range(100):\n ...\n ```\n\n---\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Minimal python API documentation generation for https://mathy.ai",
"version": "0.7.30",
"project_urls": {
"Homepage": "https://github.com/mathy/mathy_pydoc"
},
"split_keywords": [
"markdown",
"pydoc",
"generator",
"docs",
"documentation"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7411d229bc462ed116324d4792e0302beb2f121c10d7b5f452d6d87943a54d85",
"md5": "db54d981052f69abbb637891a96e0279",
"sha256": "b3b7950c7e30ca363f811a985bd5ed868b35499b482cdff82ae353fd9d818148"
},
"downloads": -1,
"filename": "mathy_pydoc-0.7.30-py3-none-any.whl",
"has_sig": false,
"md5_digest": "db54d981052f69abbb637891a96e0279",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 13632,
"upload_time": "2023-12-14T17:45:42",
"upload_time_iso_8601": "2023-12-14T17:45:42.951179Z",
"url": "https://files.pythonhosted.org/packages/74/11/d229bc462ed116324d4792e0302beb2f121c10d7b5f452d6d87943a54d85/mathy_pydoc-0.7.30-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8414bf088e5c469ebf835c1e579cc33971e6524466520935b00be3295b545a41",
"md5": "095590057678e9bcc53f1e4f6fb50d19",
"sha256": "81c32a76195ae01df1c900c0513f62ea0a943df2a23d80097ceb39a9ca93a22a"
},
"downloads": -1,
"filename": "mathy_pydoc-0.7.30.tar.gz",
"has_sig": false,
"md5_digest": "095590057678e9bcc53f1e4f6fb50d19",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 13825,
"upload_time": "2023-12-14T17:45:44",
"upload_time_iso_8601": "2023-12-14T17:45:44.651100Z",
"url": "https://files.pythonhosted.org/packages/84/14/bf088e5c469ebf835c1e579cc33971e6524466520935b00be3295b545a41/mathy_pydoc-0.7.30.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-14 17:45:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "mathy",
"github_project": "mathy_pydoc",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "mathy-pydoc"
}
JSON
