| Name | sphinx-tags-fork JSON |
| Version |
0.2.0
JSON |
| download |
| home_page | None |
| Summary | Sphinx extension to create tags for documentation pages. |
| upload_time | 2023-06-21 20:33:35 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | None |
| license | None |
| keywords |
documentation
sphinx
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# sphinx-tags [](https://circleci.com/gh/melissawm/sphinx-tags)
A tiny Sphinx extension that implements blog-style tags for documentation.
**🗣 If you use this extension in your project, please drop us a note [in this discussion post](https://github.com/melissawm/sphinx-tags/discussions/32)**
## Installation
After activating a virtual environment manager such as `venv` or `conda`, use
```
python -m pip install sphinx-tags
```
or
```
conda install sphinx-tags -c conda-forge
```
## Usage
Refer to the [documentation](https://sphinx-tags.readthedocs.io/en/latest/) for usage instructions.
## Contributing
Feel free to submit issues or PRs - keep in mind this project is experimental!
### Setup for development
After cloning this repo and activating a virtual environment manager such as
`venv` or `conda`, use
```
python -m pip install -e ".[sphinx]"
```
To build the documentation locally, use
```
sphinx-build docs docs/_build/html
```
`sphinx-tags` uses [pre-commit](https://pre-commit.com/), and code is formatted
according to [black](https://github.com/psf/black)
### Contribution guide
If you want to submit Pull requests to this repository, please follow the [contribution guidelines](https://sphinx-tags.readthedocs.io/en/latest/dev/index.html).
## Code of Conduct
All contributors and maintainers are expected to follow the
[PSF Code of Conduct](https://github.com/psf/community-code-of-conduct).
## Notes
This project is loosely based on [this StackOverflow answer](https://stackoverflow.com/questions/18146107/how-to-add-blog-style-tags-in-restructuredtext-with-sphinx).
Raw data
{
"_id": null,
"home_page": null,
"name": "sphinx-tags-fork",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "documentation,sphinx",
"author": null,
"author_email": "alex <alexurban12@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/40/48/dc6708828450d245566e591fa76a4ff95c2b9960b4d0f12b99b97aace547/sphinx_tags_fork-0.2.0.tar.gz",
"platform": null,
"description": "# sphinx-tags [](https://circleci.com/gh/melissawm/sphinx-tags)\n\nA tiny Sphinx extension that implements blog-style tags for documentation.\n\n**\ud83d\udde3 If you use this extension in your project, please drop us a note [in this discussion post](https://github.com/melissawm/sphinx-tags/discussions/32)**\n\n## Installation\n\nAfter activating a virtual environment manager such as `venv` or `conda`, use\n\n```\npython -m pip install sphinx-tags\n```\nor\n\n```\nconda install sphinx-tags -c conda-forge\n```\n\n## Usage\n\nRefer to the [documentation](https://sphinx-tags.readthedocs.io/en/latest/) for usage instructions.\n\n## Contributing\n\nFeel free to submit issues or PRs - keep in mind this project is experimental!\n\n### Setup for development\n\nAfter cloning this repo and activating a virtual environment manager such as\n`venv` or `conda`, use\n\n```\npython -m pip install -e \".[sphinx]\"\n```\n\nTo build the documentation locally, use\n\n```\nsphinx-build docs docs/_build/html\n```\n\n`sphinx-tags` uses [pre-commit](https://pre-commit.com/), and code is formatted\naccording to [black](https://github.com/psf/black)\n\n### Contribution guide\n\nIf you want to submit Pull requests to this repository, please follow the [contribution guidelines](https://sphinx-tags.readthedocs.io/en/latest/dev/index.html).\n\n## Code of Conduct\n\nAll contributors and maintainers are expected to follow the\n[PSF Code of Conduct](https://github.com/psf/community-code-of-conduct).\n\n## Notes\n\nThis project is loosely based on [this StackOverflow answer](https://stackoverflow.com/questions/18146107/how-to-add-blog-style-tags-in-restructuredtext-with-sphinx).\n",
"bugtrack_url": null,
"license": null,
"summary": "Sphinx extension to create tags for documentation pages.",
"version": "0.2.0",
"project_urls": {
"Home": "https://github.com/melissawm/sphinx-tags"
},
"split_keywords": [
"documentation",
"sphinx"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "41363291593e2cb3ea7fad251ef9665e51f942526f7c7bc00262f3c756c96ca8",
"md5": "93fcd08ed4a697f5eb7fe3238cb2131b",
"sha256": "34d51fea275cd0162ea9ff1357c0d9204fc2cbd9a37eb9c3c102fd82b4bd9255"
},
"downloads": -1,
"filename": "sphinx_tags_fork-0.2.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "93fcd08ed4a697f5eb7fe3238cb2131b",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 6463,
"upload_time": "2023-06-21T20:33:31",
"upload_time_iso_8601": "2023-06-21T20:33:31.912211Z",
"url": "https://files.pythonhosted.org/packages/41/36/3291593e2cb3ea7fad251ef9665e51f942526f7c7bc00262f3c756c96ca8/sphinx_tags_fork-0.2.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "4048dc6708828450d245566e591fa76a4ff95c2b9960b4d0f12b99b97aace547",
"md5": "8a8dc93191fd09f7061bf95ae3e19e52",
"sha256": "5eb4f3e8c32163e8cb7ae20ddb074cef1e6970888802f0373191a9c6ced61979"
},
"downloads": -1,
"filename": "sphinx_tags_fork-0.2.0.tar.gz",
"has_sig": false,
"md5_digest": "8a8dc93191fd09f7061bf95ae3e19e52",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6269,
"upload_time": "2023-06-21T20:33:35",
"upload_time_iso_8601": "2023-06-21T20:33:35.237314Z",
"url": "https://files.pythonhosted.org/packages/40/48/dc6708828450d245566e591fa76a4ff95c2b9960b4d0f12b99b97aace547/sphinx_tags_fork-0.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-21 20:33:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "melissawm",
"github_project": "sphinx-tags",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"circle": true,
"lcname": "sphinx-tags-fork"
}
