| Name | sphinx-nekochan JSON |
| Version |
0.3.3
JSON |
| download |
| home_page | None |
| Summary | A Sphinx extension for adding the Nekochan(cat) emoji to documents. |
| upload_time | 2025-03-22 06:58:40 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | None |
| keywords |
sphinx
extension
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# sphinx-nekochan
[![PyPI][pypi-badge]][pypi-link]
[![Python versions][versions-badge]][pypi-link]
[![GitHub Actions][github-ci-badge]][github-ci-link]
[![Documentation status][rtd-badge]][rtd-link]
[![PyPI - Download][downloads-badge]][downloads-link]
[![License][license-badge]][license-link]
[pypi-badge]: https://img.shields.io/pypi/v/sphinx-nekochan.svg
[pypi-link]: https://pypi.org/project/sphinx-nekochan/
[versions-badge]: https://img.shields.io/pypi/pyversions/sphinx-nekochan.svg
[github-ci-badge]: https://github.com/takanory/sphinx-nekochan/actions/workflows/workflow.yml/badge.svg
[github-ci-link]: https://github.com/takanory/sphinx-nekochan/actions
[rtd-badge]: https://readthedocs.org/projects/sphinx-nekochan/badge/?version=latest
[rtd-link]: https://sphinx-nekochan.readthedocs.io/
[downloads-badge]: https://img.shields.io/pypi/dm/sphinx-nekochan.svg
[downloads-link]: https://pypistats.org/packages/sphinx-nekochan
[license-badge]: https://img.shields.io/pypi/l/sphinx-nekochan.svg
[license-link]: https://github.com/takanory/sphinx-nekochan/blob/main/LICENSE
A Sphinx extension for adding the **Nekochan(cat) emoji** to documents.
See [the sphinx-nekochan documantation](https://sphinx-nekochan.readthedocs.io/) for more details.
## Installation
You can install `sphinx-nekochan` with `pip`:
```
pip install sphinx-nekochan
```
## Enable extension
In your `conf.py` configuration file, add `sphinx_nekochan` to your extensions list:
```python
extensions = [
...
"sphinx_nekochan",
...
]
```
## Use `nekochan` role or directive
When you use the `nekochan` roll or directive, you will see any nekochan emoji.
* markdown
````markdown
Welcome to nekochan emoji {nekochan}`banzai` world!!
* Enjoy nekochan emoji {nekochan}`choo-choo-train`
* I love {nekochan}`beer`
```{nekochan} melty
```
````
* reStructuredText
```rst
Welcome to nekochan emoji :nekochan:`banzai` world!!
* Enjoy nekochan emoji :nekochan:`choo-choo-train`
* I love :nekochan:`beer`
.. nekochan:: melty
```
## Customize emoji height and alt text
You can specify height and alt text with a semicolon(`;`) after the name of the `nekochan` role.
* markdown
````markdown
* Big bear nekochan {nekochan}`kuma-nya;2em`
* Huge hot-sprint nekochan {nekochan}`hot-spring;128px`
* Customize alt text for emoji {nekochan}`gohan-taberu;3em;Nekochan eating rice ball`
```{nekochan} lgtm
:alt: Looks Good To Me
:height: 3em
```
````
* reStructuredText
```rst
* Big bear nekochan :nekochan:`kuma-nya;2em`
* Huge hot-sprint nekochan :nekochan:`hot-spring;128px`
* Customize alt text for emoji :nekochan:`gohan-taberu;3em;Nekochan eating rice ball`
.. nekochan:: lgtm
:alt: Looks Good To Me
:height: 3em
```
## Transform emoji
Also, you can specify transform option with a semicolon(`;`) after the alt text of the `nekochan` role.
* markdown
````markdown
* Skip {nekochan}`skip-nya;2em` rotated 90 degrees clockwise {nekochan}`skip-nya;2em;;rotate-90`
* Flip the left and right side of the {nekochan}`yoshi;2em` Yoshi emoji {nekochan}`yoshi;2em;;flip-horizontal`
```{nekochan} snake
:transform: flip-vertical
:height: 2em
```
````
* reStructuredText
```rst
* Skip :nekochan:`skip-nya;2em` rotated 90 degrees clockwise :nekochan:`skip-nya;2em;;rotate-90`
* Flip the left and right side of the :nekochan:`yoshi;2em` Yoshi emoji :nekochan:`yoshi;2em;;flip-horizontal`
.. nekochan:: snake
:transform: flip-vertical
:height: 2em
```
## License
* sphinx-nekochan is licensed under the MIT License.
* Please refer to the following guidelines for using Nekochan emojis.
* [Guidelines for Using Cat Emojis](https://note.com/shikamatsu/n/n8818bb5ebea1#8b38f78f-1883-46c6-a596-63d9bf4c69da)
Raw data
{
"_id": null,
"home_page": null,
"name": "sphinx-nekochan",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "sphinx, extension",
"author": null,
"author_email": "Takanori Suzuki <takanori@takanory.net>",
"download_url": "https://files.pythonhosted.org/packages/b7/b0/15bf1977898366329ae770ea36f26a3d231f5d47cf704c10fb26341cd823/sphinx_nekochan-0.3.3.tar.gz",
"platform": null,
"description": "# sphinx-nekochan\n\n[![PyPI][pypi-badge]][pypi-link]\n[![Python versions][versions-badge]][pypi-link]\n[![GitHub Actions][github-ci-badge]][github-ci-link]\n[![Documentation status][rtd-badge]][rtd-link]\n[![PyPI - Download][downloads-badge]][downloads-link]\n[![License][license-badge]][license-link]\n\n[pypi-badge]: https://img.shields.io/pypi/v/sphinx-nekochan.svg\n[pypi-link]: https://pypi.org/project/sphinx-nekochan/\n[versions-badge]: https://img.shields.io/pypi/pyversions/sphinx-nekochan.svg\n[github-ci-badge]: https://github.com/takanory/sphinx-nekochan/actions/workflows/workflow.yml/badge.svg\n[github-ci-link]: https://github.com/takanory/sphinx-nekochan/actions\n[rtd-badge]: https://readthedocs.org/projects/sphinx-nekochan/badge/?version=latest\n[rtd-link]: https://sphinx-nekochan.readthedocs.io/\n[downloads-badge]: https://img.shields.io/pypi/dm/sphinx-nekochan.svg\n[downloads-link]: https://pypistats.org/packages/sphinx-nekochan\n[license-badge]: https://img.shields.io/pypi/l/sphinx-nekochan.svg\n[license-link]: https://github.com/takanory/sphinx-nekochan/blob/main/LICENSE\n\nA Sphinx extension for adding the **Nekochan(cat) emoji** to documents.\n\nSee [the sphinx-nekochan documantation](https://sphinx-nekochan.readthedocs.io/) for more details.\n\n## Installation\n\nYou can install `sphinx-nekochan` with `pip`:\n\n```\npip install sphinx-nekochan\n```\n\n## Enable extension\n\nIn your `conf.py` configuration file, add `sphinx_nekochan` to your extensions list:\n\n```python\nextensions = [\n ...\n \"sphinx_nekochan\",\n ...\n]\n```\n\n## Use `nekochan` role or directive\n\nWhen you use the `nekochan` roll or directive, you will see any nekochan emoji.\n\n* markdown\n\n````markdown\nWelcome to nekochan emoji {nekochan}`banzai` world!!\n\n* Enjoy nekochan emoji {nekochan}`choo-choo-train`\n* I love {nekochan}`beer`\n\n```{nekochan} melty\n```\n````\n\n* reStructuredText\n\n```rst\nWelcome to nekochan emoji :nekochan:`banzai` world!!\n\n* Enjoy nekochan emoji :nekochan:`choo-choo-train`\n* I love :nekochan:`beer`\n\n.. nekochan:: melty\n```\n\n\n\n## Customize emoji height and alt text\n\nYou can specify height and alt text with a semicolon(`;`) after the name of the `nekochan` role.\n\n* markdown\n\n````markdown\n* Big bear nekochan {nekochan}`kuma-nya;2em`\n* Huge hot-sprint nekochan {nekochan}`hot-spring;128px`\n* Customize alt text for emoji {nekochan}`gohan-taberu;3em;Nekochan eating rice ball`\n\n\n```{nekochan} lgtm\n:alt: Looks Good To Me\n:height: 3em\n```\n````\n\n* reStructuredText\n\n```rst\n* Big bear nekochan :nekochan:`kuma-nya;2em`\n* Huge hot-sprint nekochan :nekochan:`hot-spring;128px`\n* Customize alt text for emoji :nekochan:`gohan-taberu;3em;Nekochan eating rice ball`\n\n\n.. nekochan:: lgtm\n :alt: Looks Good To Me\n :height: 3em\n```\n\n\n\n## Transform emoji\n\nAlso, you can specify transform option with a semicolon(`;`) after the alt text of the `nekochan` role.\n\n* markdown\n\n````markdown\n* Skip {nekochan}`skip-nya;2em` rotated 90 degrees clockwise {nekochan}`skip-nya;2em;;rotate-90`\n* Flip the left and right side of the {nekochan}`yoshi;2em` Yoshi emoji {nekochan}`yoshi;2em;;flip-horizontal`\n\n```{nekochan} snake\n:transform: flip-vertical\n:height: 2em\n```\n````\n\n* reStructuredText\n\n```rst\n* Skip :nekochan:`skip-nya;2em` rotated 90 degrees clockwise :nekochan:`skip-nya;2em;;rotate-90`\n* Flip the left and right side of the :nekochan:`yoshi;2em` Yoshi emoji :nekochan:`yoshi;2em;;flip-horizontal`\n\n.. nekochan:: snake\n :transform: flip-vertical\n :height: 2em\n```\n\n\n\n## License\n\n* sphinx-nekochan is licensed under the MIT License.\n* Please refer to the following guidelines for using Nekochan emojis.\n * [Guidelines for Using Cat Emojis](https://note.com/shikamatsu/n/n8818bb5ebea1#8b38f78f-1883-46c6-a596-63d9bf4c69da)\n\n",
"bugtrack_url": null,
"license": null,
"summary": "A Sphinx extension for adding the Nekochan(cat) emoji to documents.",
"version": "0.3.3",
"project_urls": {
"Documentation": "https://sphinx-nekochan.readthedocs.io/",
"Repository": "https://github.com/takanory/sphinx-nekochan"
},
"split_keywords": [
"sphinx",
" extension"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "b242c0ddfe48fa30d54ebce5b6046d857a97488d4acfe18f11d75f32146d2424",
"md5": "ad816da6e38a695ad82dd7a5e92f0485",
"sha256": "2ace3e21286e6d59be399071c372a156428263bbf11e38618611d3f51945774c"
},
"downloads": -1,
"filename": "sphinx_nekochan-0.3.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ad816da6e38a695ad82dd7a5e92f0485",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 5427815,
"upload_time": "2025-03-22T06:58:38",
"upload_time_iso_8601": "2025-03-22T06:58:38.223768Z",
"url": "https://files.pythonhosted.org/packages/b2/42/c0ddfe48fa30d54ebce5b6046d857a97488d4acfe18f11d75f32146d2424/sphinx_nekochan-0.3.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "b7b015bf1977898366329ae770ea36f26a3d231f5d47cf704c10fb26341cd823",
"md5": "dff98b71b7d2b0eb515bdd6297ac48d5",
"sha256": "0845e420009c238c67e94b509568cb9d234d945acf6db773832fbf33f6dcd03a"
},
"downloads": -1,
"filename": "sphinx_nekochan-0.3.3.tar.gz",
"has_sig": false,
"md5_digest": "dff98b71b7d2b0eb515bdd6297ac48d5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 5429835,
"upload_time": "2025-03-22T06:58:40",
"upload_time_iso_8601": "2025-03-22T06:58:40.609239Z",
"url": "https://files.pythonhosted.org/packages/b7/b0/15bf1977898366329ae770ea36f26a3d231f5d47cf704c10fb26341cd823/sphinx_nekochan-0.3.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-03-22 06:58:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "takanory",
"github_project": "sphinx-nekochan",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "sphinx-nekochan"
}
