Metadata-Version: 2.1
Name: sphinx-tags
Version: 0.1.3
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: pre-commit
Requires-Dist: pydata-sphinx-theme ; extra == "sphinx"
Requires-Dist: sphinx-design ; extra == "sphinx"
Requires-Dist: myst-parser ; extra == "sphinx"
Project-URL: Home, https://github.com/melissawm/sphinx-tags
Provides-Extra: sphinx

# sphinx-tags [![sphinx-tags](https://circleci.com/gh/melissawm/sphinx-tags.svg?style=svg)](https://circleci.com/gh/melissawm/sphinx-tags)

A tiny Sphinx extension that implements blog-style tags for documentation.

## Installation

After activating a virtual environment manager such as `venv` or `conda`, use

```
python -m pip install sphinx-tags
```

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

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

