{
    "info": {
        "author": "Niklas Rosenstein",
        "author_email": "rosensteinniklas@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 3 - Alpha",
            "Intended Audience :: Developers",
            "Intended Audience :: End Users/Desktop",
            "License :: OSI Approved :: MIT License",
            "Programming Language :: Python :: 2",
            "Programming Language :: Python :: 2.7",
            "Programming Language :: Python :: 3",
            "Programming Language :: Python :: 3.3",
            "Programming Language :: Python :: 3.4",
            "Programming Language :: Python :: 3.5",
            "Topic :: Software Development :: Code Generators",
            "Topic :: Utilities"
        ],
        "description": "## pydocmd\n\n&ndash; *insipired by the [Keras] Documentation*\n\nPydocmd uses [MkDocs] and extended [Markdown] syntax to generate beautiful\nPython API documentation.\n\n  [MkDocs]: http://www.mkdocs.org/\n  [Markdown]: https://python-markdown.github.io/\n  [Keras]: https://keras.io/\n\n__Todo__\n\n- [x] Support `+` suffix to include documented members of a module/class\n- [ ] Expand and link cross-references (eg. `#SomeClass`)\n- [ ] Parse, format and link types listed in parameter/member/raise/return type\n      docstrings (eg. `someattr (int): This is...`)\n\n## Installation\n\n    pip install pydoc-markdown\n    pip install git+https://github.com/NiklasRosenstein/pydoc-markdown.git  # latest development version\n\n## Usage\n\nPydocmd can generate plain Markdown files from Python modules using the\n`pydocmd simple` 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    pydocmd simple mypackage+ mypackage.mymodule+ > docs.md\n\nAlternatively, pydocmd wraps the MkDocs command-line interface and generates\nthe markdown pages beforehand. Simply use `pydocmd build` to build the\ndocumentation, or `pydocmd serve` to serve the documentation on a local HTTP\nserver. The `pydocmd gh-deploy` from MkDocs is also supported.\n\nA configuration file `pydocmd.yml` is required to use pydocmd in this mode.\nBelow is an example configuration. To get started, create `docs/` directory\nand a file `pydocmd.yml` inside of it. Copy the configuration below and\nadjust it to your needs, then run `pydocmd build` from the `docs/` directory.\n\n```yaml\nsite_name: \"My Documentation\"\n\n# This tells pydocmd which pages to generate from which Python modules,\n# functions and classes. At the first level is the page name, below that\n# is a tree of Python member names (modules, classes, etc.) that should be\n# documented. Higher indentation leads to smaller header size.\ngenerate:\n- baz/cool-stuff.md:\n  - foobar.baz:\n    - foobar.baz.CoolClass+     # (+ to include members)\n    - foobar.baz.some_function\n- baz/more-stuff.md:\n  - foobar.more++               # (++ to include members, and their members)\n\n# MkDocs pages configuration. The `<<` operator is sugar added by pydocmd\n# that allows you to use an external Markdown file (eg. your project's README)\n# in the documentation. The path must be relative to current working directory.\npages:\n- Home: index.md << ../README.md\n- foobar.baz:\n  - Cool Stuff: baz/cool-stuff.md\n\n# These options all show off their default values. You don't have to add\n# them to your configuration if you're fine with the default.\ndocs_dir: sources\ngens_dir: _build/pydocmd     # This will end up as the MkDocs 'docs_dir'\nsite_dir: _build/site\ntheme:    readthedocs\nloader:   pydocmd.loader.PythonLoader\npreprocessor: pydocmd.preprocessor.Preprocessor\n\n# Whether to output headers as markdown or HTML.  Used to workaround\n# https://github.com/NiklasRosenstein/pydoc-markdown/issues/11.  The default is\n# to generate HTML with unique and meaningful id tags, which can't be done with\n# markdown.\n#\n# Note: if using the simple generator mode, this will default to 'markdown'\n# instead of 'html'.\nheaders: html\n\n# Additional search path for your Python module. If you use Pydocmd from a\n# subdirectory of your project (eg. docs/), you may want to add the parent\n# directory here.\nadditional_search_paths:\n- ..\n```\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## Changes\n\n### v2.0.5 (2018-11-15)\n\n- Now copies all files from the docs_dir (to include images etc.) (see #56)\n- Fix error with delayed imports changing dictionary size during iteration (see #57)\n- Add `headers` option which can be of value `'html'` or `'markdown'` (see #55)\n- Default `headers` option to `'markdown'` in `simple` mode (see #59)\n\n### v2.0.4 (2018-07-24)\n\n- Add `-c key=value` argument for `generate` and `simple` command\n- Add `filter=[\"docstring\"]` option (#43)\n- Fix regex for detecting cross-references (#44)\n- Handle classes that don't define `__init__()` (PR#51)\n- Add support for reStructuredText Markup (eg. ``:class:`MyClass` ``) (PR#46, #1)\n- Handle `@property` functions (PR#50)\n\n### v2.0.3\n\n- Fix #41, #36, #31\n- Merged #39\n\n### v2.0.2 \n\n- Fix #25 -- Text is incorrectly rendered as code\n- Fix #26 -- Broken links for URLs with fragment identifiers\n- No longer transforms titles in a docstring that are indented (eg. to\n  avoid an indented code block with a `#` comment to be corrupted)\n\n### v2.0.1\n\n- Support `additional_search_path` key in configuration\n- Render headers as HTML `<hX>` tags rather than Markdown tags, so we\n  assign a proper ID to them\n- Fix #21 -- AttributeError: 'module' object has no attribute 'signature'\n- Now requires the `six` module\n- FIx #22 -- No blank space after header does not render codeblocks\n\n### v2.0.0\n\n- Complete overhaul of **pydoc-markdown** employing MkDocs and the Markdown module.\n\n---\n\n<p align=\"center\">Copyright &copy; 2017-2018  Niklas Rosenstein</p>",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/NiklasRosenstein/pydoc-markdown",
        "keywords": "markdown pydoc generator docs documentation",
        "license": "MIT",
        "maintainer": "",
        "maintainer_email": "",
        "name": "pydoc-markdown",
        "package_url": "https://pypi.org/project/pydoc-markdown/",
        "platform": "",
        "project_url": "https://pypi.org/project/pydoc-markdown/",
        "project_urls": {
            "Homepage": "https://github.com/NiklasRosenstein/pydoc-markdown"
        },
        "release_url": "https://pypi.org/project/pydoc-markdown/2.0.5/",
        "requires_dist": null,
        "requires_python": "",
        "summary": "Create Python API documentation in Markdown format",
        "version": "2.0.5"
    },
    "last_serial": 4491149,
    "releases": {
        "0.1.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "2e819c18fc4c56002c3848dc852b8d30",
                    "sha256": "6b281cee1909b96f8b4f4d6ada7b4a1ee7c50564fa18c1392cf23372c590227b"
                },
                "downloads": -1,
                "filename": "pydoc-markdown-0.1.0.zip",
                "has_sig": false,
                "md5_digest": "2e819c18fc4c56002c3848dc852b8d30",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 12057,
                "upload_time": "2016-04-04T09:53:05",
                "url": "https://files.pythonhosted.org/packages/90/4a/e30686ea4a7068960ec2385e4745b9deceb1090cff06d222a0c0127b2d12/pydoc-markdown-0.1.0.zip"
            }
        ],
        "2.0.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "89e357ace2d90e61a8f37fdbe524d6e2",
                    "sha256": "c5f3a3f607d426f9d5cd6a1bb517b0e830f8c96b3ae8ba096511ae2fe229783b"
                },
                "downloads": -1,
                "filename": "pydoc-markdown-2.0.0.zip",
                "has_sig": false,
                "md5_digest": "89e357ace2d90e61a8f37fdbe524d6e2",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 26064,
                "upload_time": "2017-05-02T10:44:37",
                "url": "https://files.pythonhosted.org/packages/4c/54/da010c09bac1a5fff2bb19c0e894ca88c3373d47ba22917881253fc9e634/pydoc-markdown-2.0.0.zip"
            }
        ],
        "2.0.0.dev0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "26ff3c4c9364af9645c27a531349d0a9",
                    "sha256": "2737f042c7094be103c8655fab444d1b7dadf6d9b659fa7708ba2be226d848ca"
                },
                "downloads": -1,
                "filename": "pydoc-markdown-2.0.0.dev0.tar.gz",
                "has_sig": false,
                "md5_digest": "26ff3c4c9364af9645c27a531349d0a9",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 12641,
                "upload_time": "2017-01-05T19:25:02",
                "url": "https://files.pythonhosted.org/packages/82/27/5ca6e9167935e4a2587445a7119bd043a57fc187cb5c9eaa079e51579975/pydoc-markdown-2.0.0.dev0.tar.gz"
            }
        ],
        "2.0.1": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "1d45602d536c1b23c8dc6b8dadad1584",
                    "sha256": "ba8a74936cd7f95ab90176623a61b04fbf001fe95a5b14babc94252aa4b7ae92"
                },
                "downloads": -1,
                "filename": "pydoc-markdown-2.0.1.tar.gz",
                "has_sig": false,
                "md5_digest": "1d45602d536c1b23c8dc6b8dadad1584",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 15660,
                "upload_time": "2017-05-27T10:29:23",
                "url": "https://files.pythonhosted.org/packages/ac/82/8240092e3892e7f6114b4d0dddf9dd9e97117422f8dad11f3a022ceb3c23/pydoc-markdown-2.0.1.tar.gz"
            }
        ],
        "2.0.2": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "9afb07335ad540bb097e1ccb8d27af98",
                    "sha256": "183d475e1e5acc568b186c7c23fc0faec9770a42cbddadcf6fbfe7565aa055c0"
                },
                "downloads": -1,
                "filename": "pydoc-markdown-2.0.2.tar.gz",
                "has_sig": false,
                "md5_digest": "9afb07335ad540bb097e1ccb8d27af98",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 16134,
                "upload_time": "2018-03-20T12:51:23",
                "url": "https://files.pythonhosted.org/packages/4c/60/91837c148cd4a6317af648a2b382a02302be4332f148dbb20ace89c07066/pydoc-markdown-2.0.2.tar.gz"
            }
        ],
        "2.0.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "43e5002e460f7d1f3aba1cdc8d507baa",
                    "sha256": "0086e958046c08cc99aefc40e3e2509a686c5a18e53db11b28a44570f128f83e"
                },
                "downloads": -1,
                "filename": "pydoc-markdown-2.0.3.tar.gz",
                "has_sig": false,
                "md5_digest": "43e5002e460f7d1f3aba1cdc8d507baa",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 16476,
                "upload_time": "2018-05-03T17:40:04",
                "url": "https://files.pythonhosted.org/packages/68/78/e5c3ccbdb7d427eef44112a245ee52283842192b0ab8b0fd706aeff0b6b0/pydoc-markdown-2.0.3.tar.gz"
            }
        ],
        "2.0.4": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "e0037f6a28d37f6943faec455302570f",
                    "sha256": "a9baef97d275ee5b197524e44792c154dd51feea20e23cbdcedb95cc3eac2985"
                },
                "downloads": -1,
                "filename": "pydoc-markdown-2.0.4.tar.gz",
                "has_sig": false,
                "md5_digest": "e0037f6a28d37f6943faec455302570f",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 17797,
                "upload_time": "2018-07-24T16:18:02",
                "url": "https://files.pythonhosted.org/packages/2d/df/eecbaa9dd5616b2b8c40fc4c4e62f499fd4a23a9272cf92b8b2c1033de10/pydoc-markdown-2.0.4.tar.gz"
            }
        ],
        "2.0.5": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "e6eb19cd3cf0409bd9da8abf5d92c757",
                    "sha256": "f1511ad5a6ca33a52dd2010651d18e9debb57bcf36ab87eca560dd15a753ce1f"
                },
                "downloads": -1,
                "filename": "pydoc-markdown-2.0.5.tar.gz",
                "has_sig": false,
                "md5_digest": "e6eb19cd3cf0409bd9da8abf5d92c757",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 14305,
                "upload_time": "2018-11-15T20:39:26",
                "url": "https://files.pythonhosted.org/packages/d6/fa/163d1254426f7fa45fd5e6fce8f75cd18165e28971595edbe26e12e61d8c/pydoc-markdown-2.0.5.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "e6eb19cd3cf0409bd9da8abf5d92c757",
                "sha256": "f1511ad5a6ca33a52dd2010651d18e9debb57bcf36ab87eca560dd15a753ce1f"
            },
            "downloads": -1,
            "filename": "pydoc-markdown-2.0.5.tar.gz",
            "has_sig": false,
            "md5_digest": "e6eb19cd3cf0409bd9da8abf5d92c757",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 14305,
            "upload_time": "2018-11-15T20:39:26",
            "url": "https://files.pythonhosted.org/packages/d6/fa/163d1254426f7fa45fd5e6fce8f75cd18165e28971595edbe26e12e61d8c/pydoc-markdown-2.0.5.tar.gz"
        }
    ]
}