| Name | Sphinx-AutoMark JSON |
| Version |
0.0.0.2
JSON |
| download |
| home_page | None |
| Summary | A tool for generating Sphinx Autodoc's directive based on decorated functions and classes in code. |
| upload_time | 2024-04-14 17:31:43 |
| maintainer | None |
| docs_url | None |
| author | David Hozic |
| requires_python | >=3.8 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
=========================================================
Sphinx-AutoMark
=========================================================
A tool for generating Sphinx Autodoc's directive based on decorated functions and classes in code.
---------------------
Links
---------------------
- `Releases <https://github.com/davidhozic/Sphinx-AutoMark/releases>`_
- Need help? Contact me in my `Discord server <https://discord.gg/DEnvahb2Sw>`_.
----------------------
Example
----------------------
.. code-block:: python
import sphinx_automark as mark
cat1 = mark.MultiCategory("API docs", "This is a test category 1\nJust to see if it works normally.", "./docs/source/")
cat2 = mark.MultiCategory("Test category 2", "This is a test category 2\nJust to see if it works normally.")
cat3 = mark.Category("Normal category", "This is a normal category, implemented inside a file.")
cat1.add_categories(cat2)
cat2.add_categories(cat3)
@cat2.mark
class TestCls:
"""
This is a test class.
"""
class TestCls2:
"""
This is a test class.
"""
cat2.mark(TestCls2)
@cat3.mark(members=True, special_members=True, private_members=True, inherited_members=True)
class TestCls3:
"""
This is a test class.
"""
def tesT(self):
"""
Some method eh
"""
@cat3.mark
def good_fnc():
"""
This is a good fnc.
"""
Raw data
{
"_id": null,
"home_page": null,
"name": "Sphinx-AutoMark",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "David Hozic",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/d4/b6/454ec25e221257887e910f7be0dc857dd117f6699eac17e62bc4f7d80e73/Sphinx-AutoMark-0.0.0.2.tar.gz",
"platform": null,
"description": "=========================================================\nSphinx-AutoMark\n=========================================================\nA tool for generating Sphinx Autodoc's directive based on decorated functions and classes in code.\n\n---------------------\nLinks\n---------------------\n- `Releases <https://github.com/davidhozic/Sphinx-AutoMark/releases>`_\n- Need help? Contact me in my `Discord server <https://discord.gg/DEnvahb2Sw>`_.\n\n----------------------\nExample\n----------------------\n\n.. code-block:: python\n\n import sphinx_automark as mark\n\n cat1 = mark.MultiCategory(\"API docs\", \"This is a test category 1\\nJust to see if it works normally.\", \"./docs/source/\")\n cat2 = mark.MultiCategory(\"Test category 2\", \"This is a test category 2\\nJust to see if it works normally.\")\n cat3 = mark.Category(\"Normal category\", \"This is a normal category, implemented inside a file.\")\n\n cat1.add_categories(cat2)\n cat2.add_categories(cat3)\n\n @cat2.mark\n class TestCls:\n \"\"\"\n This is a test class.\n \"\"\"\n\n class TestCls2:\n \"\"\"\n This is a test class.\n \"\"\"\n\n cat2.mark(TestCls2)\n\n @cat3.mark(members=True, special_members=True, private_members=True, inherited_members=True)\n class TestCls3:\n \"\"\"\n This is a test class.\n \"\"\"\n def tesT(self):\n \"\"\"\n Some method eh\n \"\"\"\n @cat3.mark\n def good_fnc():\n \"\"\"\n This is a good fnc.\n \"\"\"\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "A tool for generating Sphinx Autodoc's directive based on decorated functions and classes in code.",
"version": "0.0.0.2",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dd6b5765e6c12b63d4b998245685b7e4501d3c5d49391a4bdb33a1fe2a16296d",
"md5": "d61886fb0b9603a247fe7813ac8beb8b",
"sha256": "4e4beaf53b645842e284c632a232532f300dd3efa5cd15ca3ff28eacbbd8b949"
},
"downloads": -1,
"filename": "Sphinx_AutoMark-0.0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d61886fb0b9603a247fe7813ac8beb8b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 8678,
"upload_time": "2024-04-14T17:31:42",
"upload_time_iso_8601": "2024-04-14T17:31:42.803242Z",
"url": "https://files.pythonhosted.org/packages/dd/6b/5765e6c12b63d4b998245685b7e4501d3c5d49391a4bdb33a1fe2a16296d/Sphinx_AutoMark-0.0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d4b6454ec25e221257887e910f7be0dc857dd117f6699eac17e62bc4f7d80e73",
"md5": "d5338cd2348d5c9a5763545455c87207",
"sha256": "3e50c4f5796b953ab3d8874cf35ad7d13d74fbd72c9580a07cfee04f50952a96"
},
"downloads": -1,
"filename": "Sphinx-AutoMark-0.0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "d5338cd2348d5c9a5763545455c87207",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 6543,
"upload_time": "2024-04-14T17:31:43",
"upload_time_iso_8601": "2024-04-14T17:31:43.727970Z",
"url": "https://files.pythonhosted.org/packages/d4/b6/454ec25e221257887e910f7be0dc857dd117f6699eac17e62bc4f7d80e73/Sphinx-AutoMark-0.0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-14 17:31:43",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "sphinx-automark"
}
