mkdocs-py-ref-gen

Name	mkdocs-py-ref-gen JSON
Version	0.1.1 JSON
	download
home_page	https://github.com/leninkhaidem/mkdocs-python-ref-generator
Summary	mkdocs plugin to generate reference documentation and summary of python package(s)
upload_time	2024-10-27 08:44:57
maintainer	None
docs_url	None
author	Lenin Khaidem
requires_python	<4.0,>=3.9
license	MIT
keywords	mkdocs mkdocs-plugin docstrings autodoc documentation mkdocstrings[python] python
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # mkdocs-py-ref-gen

mkdocs plugin to generate reference documentation and summary of python package(s)

It's a wrapper plugin built using [mkdocs-gen-file](https://github.com/oprypin/)

```shell
pip install mkdocs-py-ref-gen
```

## usage

```yaml
plugins:
    - py-ref-gen
        modules:
            - name: "my_module"

```

[Click me](https://leninkhaidem.github.io/mkdocs-python-ref-generator) for full documention

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/leninkhaidem/mkdocs-python-ref-generator",
    "name": "mkdocs-py-ref-gen",
    "maintainer": null,
    "docs_url": null,
    "requires_python": "<4.0,>=3.9",
    "maintainer_email": null,
    "keywords": "mkdocs, mkdocs-plugin, docstrings, autodoc, documentation, mkdocstrings[python], python",
    "author": "Lenin Khaidem",
    "author_email": "leninkhaidem@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/ec/fc/2acbfeb9b3334e922875142105aede3225305101cff63a8045aa586a64c2/mkdocs_py_ref_gen-0.1.1.tar.gz",
    "platform": null,
    "description": "# mkdocs-py-ref-gen\n\nmkdocs plugin to generate reference documentation and summary of python package(s)\n\nIt's a wrapper plugin built using [mkdocs-gen-file](https://github.com/oprypin/)\n\n```shell\npip install mkdocs-py-ref-gen\n```\n\n## usage\n\n```yaml\nplugins:\n    - py-ref-gen\n        modules:\n            - name: \"my_module\"\n\n```\n\n[Click me](https://leninkhaidem.github.io/mkdocs-python-ref-generator) for full documention\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "mkdocs plugin to generate reference documentation and summary of python package(s)",
    "version": "0.1.1",
    "project_urls": {
        "Documentation": "https://leninkhaidem.github.io/mkdocs-python-ref-generator/",
        "Homepage": "https://github.com/leninkhaidem/mkdocs-python-ref-generator",
        "Repository": "https://github.com/leninkhaidem/mkdocs-python-ref-generator"
    },
    "split_keywords": [
        "mkdocs",
        " mkdocs-plugin",
        " docstrings",
        " autodoc",
        " documentation",
        " mkdocstrings[python]",
        " python"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "29fae5ad3ba17a01b7b94010af0733e3cc1f6cedd48518f60844e84d5bc02295",
                "md5": "e61e261164a5242eb0cb41e7d5ec2d8a",
                "sha256": "af1f1a10f3dfe5d7bf9ef325d62b9557b6d9ffabd1f021da53658f170342bcfc"
            },
            "downloads": -1,
            "filename": "mkdocs_py_ref_gen-0.1.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "e61e261164a5242eb0cb41e7d5ec2d8a",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.9",
            "size": 6769,
            "upload_time": "2024-10-27T08:44:55",
            "upload_time_iso_8601": "2024-10-27T08:44:55.987262Z",
            "url": "https://files.pythonhosted.org/packages/29/fa/e5ad3ba17a01b7b94010af0733e3cc1f6cedd48518f60844e84d5bc02295/mkdocs_py_ref_gen-0.1.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ecfc2acbfeb9b3334e922875142105aede3225305101cff63a8045aa586a64c2",
                "md5": "999c28482e25291afb0ff66242d78946",
                "sha256": "61391308df86d63a1dbf9a5bbf58d9fb183ea56776d7fac57aee4a255dfc9185"
            },
            "downloads": -1,
            "filename": "mkdocs_py_ref_gen-0.1.1.tar.gz",
            "has_sig": false,
            "md5_digest": "999c28482e25291afb0ff66242d78946",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.9",
            "size": 5275,
            "upload_time": "2024-10-27T08:44:57",
            "upload_time_iso_8601": "2024-10-27T08:44:57.636901Z",
            "url": "https://files.pythonhosted.org/packages/ec/fc/2acbfeb9b3334e922875142105aede3225305101cff63a8045aa586a64c2/mkdocs_py_ref_gen-0.1.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-10-27 08:44:57",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "leninkhaidem",
    "github_project": "mkdocs-python-ref-generator",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "mkdocs-py-ref-gen"
}