Metadata-Version: 2.1
Name: sphinx-tags
Version: 0.3.0
Summary: Sphinx extension to create tags for documentation pages.
Keywords: documentation,sphinx
Author-email: melissawm <melissawm@gmail.com>
Description-Content-Type: text/markdown
Classifier: License :: OSI Approved :: MIT License
Requires-Dist: sphinx>4
Requires-Dist: bs4 ; extra == "dev"
Requires-Dist: pytest>=6.0 ; extra == "dev"
Requires-Dist: pytest-cov ; extra == "dev"
Requires-Dist: pre-commit ; extra == "dev"
Requires-Dist: pydata-sphinx-theme ; extra == "sphinx"
Requires-Dist: sphinx-design ; extra == "sphinx"
Requires-Dist: nbsphinx ; extra == "sphinx"
Requires-Dist: myst-parser ; extra == "sphinx"
Project-URL: Home, https://github.com/melissawm/sphinx-tags
Provides-Extra: dev
Provides-Extra: sphinx

# 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/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).

