search

melissawm / sphinx-tags

A tiny Sphinx extension that implements blog-style tags for documentation.
https://sphinx-tags.readthedocs.io/en/latest/
MIT License
44 stars 11 forks source link

Enable multiline tags #102

Closed melissawm closed 1 month ago

melissawm commented 2 months ago

Hi folks, this is a ridiculously ugly temporary solution for the parsing of multiline tags while we work on #101 and #92 . I am pretty sure I have a way forward with a more "sphinxy" approach using the domain, but I won't have the time to finish this before SciPy.

This PR adds a multiline parser for the tags in Entry - like I said it is ugly but seems to work on the simpler cases. If you agree with testing this as a temporary solution, we can cut a 0.3.2 and keep working on the domain approach for a 1.0 later.

cc @story645

melissawm commented 2 months ago

Tests are failing but on readthedocs it seems all is fine.

story645 commented 2 months ago

Um wow thanks for working so much on this. I'm perfectly fine w/ a temporary hack assuming it doesn't go chaotic .

@qulogic can you think of any issues to the mpl doc build if we move tags to this release?

JWCook commented 2 months ago

@melissawm #103 should fix the test failures you're seeing here.

melissawm commented 1 month ago

I'm going to merge and cut a release since I think this is the best way to test it with at least a local matplotlib build. If it doesn't work, at least we tried :) Thank you all so much!