- This repo is a fork. Here is the original repo for reference.
- 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
This fork adds on to the original repo by doing the following:
- Allow direct embedding of tags in .ipynb files. This can be done by adding an reST cell to a jupyter notebook and tagging in usual way i.e.
.. tags:: tag1, tag2
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
Refer to the documentation for usage instructions.
Feel free to submit issues or PRs - keep in mind this project is experimental!
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, and code is formatted
according to black
If you want to submit Pull requests to this repository, please follow the contribution guidelines.
All contributors and maintainers are expected to follow the PSF Code of Conduct.
This project is loosely based on this StackOverflow answer.