nmk-doc

Name	nmk-doc JSON
Version	1.0.2 JSON
	download
home_page	None
Summary	Documentation handling plugin for nmk build system
upload_time	2024-12-30 16:17:37
maintainer	The dynod project
docs_url	None
author	The dynod project
requires_python	>=3.9
license	MIT License
keywords
VCS
bugtrack_url
requirements	build myst-parser nmk-base nmk-doc nmk-vscode pytest-cov pytest-multilog pytest-xdist ruff setuptools sphinx sphinx-autoapi sphinx_rtd_theme wheel
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # nmk-doc
Documentation handling plugin for nmk build system

<!-- NMK-BADGES-BEGIN -->
[![License: MIT License](https://img.shields.io/github/license/dynod/nmk-doc)](https://github.com/dynod/nmk-doc/blob/main/LICENSE)
[![Checks](https://img.shields.io/github/actions/workflow/status/dynod/nmk-doc/build.yml?branch=main&label=build%20%26%20u.t.)](https://github.com/dynod/nmk-doc/actions?query=branch%3Amain)
[![Issues](https://img.shields.io/github/issues-search/dynod/nmk?label=issues&query=is%3Aopen+is%3Aissue+label%3Aplugin%3Adoc)](https://github.com/dynod/nmk/issues?q=is%3Aopen+is%3Aissue+label%3Aplugin%3Adoc)
[![Supported python versions](https://img.shields.io/badge/python-3.9%20--%203.13-blue)](https://www.python.org/)
[![PyPI](https://img.shields.io/pypi/v/nmk-doc)](https://pypi.org/project/nmk-doc/)
[![Code style: ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://astral.sh/ruff)
[![Code coverage](https://img.shields.io/codecov/c/github/dynod/nmk-doc)](https://app.codecov.io/gh/dynod/nmk-doc)
[![Documentation Status](https://readthedocs.org/projects/nmk-doc/badge/?version=stable)](https://nmk-doc.readthedocs.io/)
<!-- NMK-BADGES-END -->

This plugin provide tasks to build documentation using the [Sphinx tool](https://www.sphinx-doc.org/).

## Usage

To use this plugin in your **`nmk`** project, insert this reference:
```yaml
refs:
    - pip://nmk-doc!plugin.yml
```

## Documentation

This plugin documentation is available [here](https://nmk-doc.readthedocs.io/)

## Issues

Issues for this plugin shall be reported on the [main  **`nmk`** project](https://github.com/dynod/nmk/issues), using the **plugin:doc** label.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "nmk-doc",
    "maintainer": "The dynod project",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": null,
    "author": "The dynod project",
    "author_email": null,
    "download_url": null,
    "platform": null,
    "description": "# nmk-doc\nDocumentation handling plugin for nmk build system\n\n<!-- NMK-BADGES-BEGIN -->\n[![License: MIT License](https://img.shields.io/github/license/dynod/nmk-doc)](https://github.com/dynod/nmk-doc/blob/main/LICENSE)\n[![Checks](https://img.shields.io/github/actions/workflow/status/dynod/nmk-doc/build.yml?branch=main&label=build%20%26%20u.t.)](https://github.com/dynod/nmk-doc/actions?query=branch%3Amain)\n[![Issues](https://img.shields.io/github/issues-search/dynod/nmk?label=issues&query=is%3Aopen+is%3Aissue+label%3Aplugin%3Adoc)](https://github.com/dynod/nmk/issues?q=is%3Aopen+is%3Aissue+label%3Aplugin%3Adoc)\n[![Supported python versions](https://img.shields.io/badge/python-3.9%20--%203.13-blue)](https://www.python.org/)\n[![PyPI](https://img.shields.io/pypi/v/nmk-doc)](https://pypi.org/project/nmk-doc/)\n[![Code style: ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://astral.sh/ruff)\n[![Code coverage](https://img.shields.io/codecov/c/github/dynod/nmk-doc)](https://app.codecov.io/gh/dynod/nmk-doc)\n[![Documentation Status](https://readthedocs.org/projects/nmk-doc/badge/?version=stable)](https://nmk-doc.readthedocs.io/)\n<!-- NMK-BADGES-END -->\n\nThis plugin provide tasks to build documentation using the [Sphinx tool](https://www.sphinx-doc.org/).\n\n## Usage\n\nTo use this plugin in your **`nmk`** project, insert this reference:\n```yaml\nrefs:\n    - pip://nmk-doc!plugin.yml\n```\n\n## Documentation\n\nThis plugin documentation is available [here](https://nmk-doc.readthedocs.io/)\n\n## Issues\n\nIssues for this plugin shall be reported on the [main  **`nmk`** project](https://github.com/dynod/nmk/issues), using the **plugin:doc** label.\n",
    "bugtrack_url": null,
    "license": "MIT License",
    "summary": "Documentation handling plugin for nmk build system",
    "version": "1.0.2",
    "project_urls": {
        "Homepage": "https://github.com/dynod/nmk-doc",
        "Issues": "https://github.com/dynod/nmk/issues?q=is%3Aopen+is%3Aissue+label%3Aplugin%3Adoc",
        "Repository": "https://github.com/dynod/nmk-doc"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "822bd8e6ad14a67bd28ac5aa8e4552220618faab8dc61f3da5ed372983265856",
                "md5": "ef152747ef31003ba06dd9730e9dd1c1",
                "sha256": "3231edaf0f029a5aa51bb7561b4ad1b94790743795d244eb397a9e1df03f79bb"
            },
            "downloads": -1,
            "filename": "nmk_doc-1.0.2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "ef152747ef31003ba06dd9730e9dd1c1",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 7343,
            "upload_time": "2024-12-30T16:17:37",
            "upload_time_iso_8601": "2024-12-30T16:17:37.710582Z",
            "url": "https://files.pythonhosted.org/packages/82/2b/d8e6ad14a67bd28ac5aa8e4552220618faab8dc61f3da5ed372983265856/nmk_doc-1.0.2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-30 16:17:37",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "dynod",
    "github_project": "nmk-doc",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "build",
            "specs": []
        },
        {
            "name": "myst-parser",
            "specs": []
        },
        {
            "name": "nmk-base",
            "specs": []
        },
        {
            "name": "nmk-doc",
            "specs": []
        },
        {
            "name": "nmk-vscode",
            "specs": []
        },
        {
            "name": "pytest-cov",
            "specs": []
        },
        {
            "name": "pytest-multilog",
            "specs": []
        },
        {
            "name": "pytest-xdist",
            "specs": []
        },
        {
            "name": "ruff",
            "specs": []
        },
        {
            "name": "setuptools",
            "specs": []
        },
        {
            "name": "sphinx",
            "specs": []
        },
        {
            "name": "sphinx-autoapi",
            "specs": []
        },
        {
            "name": "sphinx_rtd_theme",
            "specs": []
        },
        {
            "name": "wheel",
            "specs": []
        }
    ],
    "lcname": "nmk-doc"
}