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

Add support for ipynb #51

Closed AlexTheLion123 closed 1 year ago

AlexTheLion123 commented 1 year ago

Details

Tasks

melissawm commented 1 year ago

Hi @AlexTheLion123 - yes ill take a look and will make sure to release after merging, can you then please add your project to the list at https://github.com/melissawm/sphinx-tags/discussions/32? I will come back here as soon as possible!

melissawm commented 1 year ago

Hi @AlexTheLion123 , I'm trying this locally and although the code runs, I can't see the tags created from the raw cell in the notebook. Can you explain how this works for you? Here's my attemp: https://github.com/melissawm/sphinx-tags/tree/add-notebook-docs

AlexTheLion123 commented 1 year ago

Hi @melissawm, apologies for the delay. You should add tags_extension = ["rst", "md", "ipynb"]. Does this work for you?

AlexTheLion123 commented 1 year ago

Hi @AlexTheLion123 - yes ill take a look and will make sure to release after merging, can you then please add your project to the list at #32? I will come back here as soon as possible!

I'll be sure to add it once we get it up and running

AlexTheLion123 commented 1 year ago

You can actually see it in action already here https://tradingstrategy.ai/docs/programming/strategy-examples/index.html#example-backtesting-jupyter-notebooks

melissawm commented 1 year ago

Ah - ok, I see the tag pages now, but the tags still don't show in my rendered notebook 🤔 I'm checking your code against mine and can't see any obvious reason for the tags to be invisible but I can't see them at all? I will merge this and follow up with docs for the release while I try to figure it out. Thanks again for the contribution 😄

EDIT: I got it - see #53

melissawm commented 1 year ago

New release is up - let me know if this is what you needed https://github.com/melissawm/sphinx-tags/releases/tag/0.2.1 Cheers!