Skip to content

Another take at a Tags domain #101

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 5 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
extensions = ["sphinx_design", "sphinx_tags", "nbsphinx", "myst_parser"]

tags_create_tags = True
tags_create_badges = True
tags_create_badges = False
# tags_output_dir = "_tags" # default
tags_overview_title = "All tags" # default: "Tags overview"
tags_extension = ["rst", "md", "ipynb"] # default: ["rst"]
Expand Down
2 changes: 2 additions & 0 deletions docs/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -120,3 +120,5 @@ files so it doesn't get stuck in a loop. Example:
sphinx-autobuild docs docs/_build/html --ignore '**/_tags/*'

If you have set ``tags_output_dir`` to a different path, use that instead of ``_tags``.

.. tags:: tag documentation
6 changes: 5 additions & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,8 @@ Check out the `list of projects that use this extension <https://github.com/meli
:maxdepth: 2
:titlesonly:

_tags/tagsindex
_tags/tagsindex.md

Indices and tables
==================
* :ref:`tags-index`
2 changes: 1 addition & 1 deletion docs/quickstart.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Quickstart

The ``sphinx-tags`` package enables the use of blog-style tags with Sphinx.

.. tags:: tag documentation, tag installation
.. tags:: tag documentation, tag installation

Tags are created using the custom directive ``.. tags::`` with the tag titles
as arguments.
Expand Down
Loading