sphinx-tags


Namesphinx-tags JSON
Version 0.4 PyPI version JSON
download
home_pageNone
SummarySphinx extension to create tags for documentation pages.
upload_time2024-07-08 15:43:24
maintainerNone
docs_urlNone
authorNone
requires_pythonNone
licenseNone
keywords documentation sphinx
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # sphinx-tags [![sphinx-tags](https://circleci.com/gh/melissawm/sphinx-tags.svg?style=svg)](https://circleci.com/gh/melissawm/sphinx-tags) ![Codecov](https://img.shields.io/codecov/c/github/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!

If you want to submit Pull requests to this repository, please follow the [contribution guidelines](https://sphinx-tags.readthedocs.io/en/latest/contribute/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",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "documentation, sphinx",
    "author": null,
    "author_email": "melissawm <melissawm@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/10/de/cd7669ce4619bf03418d428b4e68f20bc90f9de0d9ed36b1d43147d6e96d/sphinx_tags-0.4.tar.gz",
    "platform": null,
    "description": "# sphinx-tags [![sphinx-tags](https://circleci.com/gh/melissawm/sphinx-tags.svg?style=svg)](https://circleci.com/gh/melissawm/sphinx-tags) ![Codecov](https://img.shields.io/codecov/c/github/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\nIf you want to submit Pull requests to this repository, please follow the [contribution guidelines](https://sphinx-tags.readthedocs.io/en/latest/contribute/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\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Sphinx extension to create tags for documentation pages.",
    "version": "0.4",
    "project_urls": {
        "Home": "https://github.com/melissawm/sphinx-tags"
    },
    "split_keywords": [
        "documentation",
        " sphinx"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "70711fb5aa2013e04d36e6940b308e65608a48e2d5f59f2a21c98f01f2ce0b85",
                "md5": "48bc4d63069972f26a5dd4efde26e3a0",
                "sha256": "af31203fe4e0ebd39cb95d4fef38720185def6af9fdb921b70275ff659a5dac5"
            },
            "downloads": -1,
            "filename": "sphinx_tags-0.4-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "48bc4d63069972f26a5dd4efde26e3a0",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 7231,
            "upload_time": "2024-07-08T15:43:23",
            "upload_time_iso_8601": "2024-07-08T15:43:23.077225Z",
            "url": "https://files.pythonhosted.org/packages/70/71/1fb5aa2013e04d36e6940b308e65608a48e2d5f59f2a21c98f01f2ce0b85/sphinx_tags-0.4-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "10decd7669ce4619bf03418d428b4e68f20bc90f9de0d9ed36b1d43147d6e96d",
                "md5": "a81dba544b8f161a758fc5311c5e6c85",
                "sha256": "3065219bacf47567c706f2237d5665b22f3a5167367b4c4568bcda4371a5359d"
            },
            "downloads": -1,
            "filename": "sphinx_tags-0.4.tar.gz",
            "has_sig": false,
            "md5_digest": "a81dba544b8f161a758fc5311c5e6c85",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 15292,
            "upload_time": "2024-07-08T15:43:24",
            "upload_time_iso_8601": "2024-07-08T15:43:24.068264Z",
            "url": "https://files.pythonhosted.org/packages/10/de/cd7669ce4619bf03418d428b4e68f20bc90f9de0d9ed36b1d43147d6e96d/sphinx_tags-0.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-07-08 15:43:24",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "melissawm",
    "github_project": "sphinx-tags",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "circle": true,
    "lcname": "sphinx-tags"
}
        
Elapsed time: 3.93929s