DOC: Support dynamic filtering by tags for gallery examples with Sphinx-Gallery v0.21.0
I maintainer di solito rispondono entro 1 giorno
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 5/5
- Tempo stimato
- Più di una settimana
- Idoneità per principianti
- 42/100
- Tipo di issue
- Documentazione
- Chiarezza
- Abbastanza chiara
- Stato di attività
- Tranquilla
- Stack tecnologico
- python
- Ambito
- documentation
Direzione di ricerca
Leggi prima la documentazione del tagging di Sphinx-Gallery v0.21.0 e la demo della galleria collegata. Esamina gli esempi di galleria esistenti, la configurazione di Sphinx-Gallery e le guide per contribuire per definire i tag consentiti e dove devono essere documentati. Il lavoro è completo quando l’elenco dei tag è concordato e documentato, gli esempi utilizzano il meccanismo di tagging e la documentazione pertinente sulla navigazione o sui contributi è aggiornata.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Sphinx-Gallery v0.21.0 introduces tag support for gallery examples, which allows examples to be tagged and filtered more effectively. See https://sphinx-gallery.github.io/stable/configuration.html#tagging-examples-and-filtering for the usage and https://sphinx-gallery.github.io/stable/auto_examples/index.html?#general-examples for a live demo.
This feature would be very beneficial for the PyGMT gallery, which has grown substantially and can be difficult to navigate, especially for new users. Tag support would allow:
- Better discoverability of examples
- More flexible navigation
- Easier onboarding for new users
- Improved documentation structure without major reorganization
Potential checklist
- Decide if we want to support tags
- Decide on the list of allowed tags for PyGMT
- Document the list of allowed tags
- Upgrade to Sphinx-Gallery ≥ 0.21.0
- Add tags to gallery examples using the new tagging mechanism [definitely in multiple PRs]
- See if we should reorganize the structure of the gallery
- Update contributing guides
- Lingua principale
- Python
- Stelle
- 875
- Fork
- 256
- Merge medio
- 2g 22h
- PR unite (30g)
- 43
Preparare l'ambiente
- Nessun Dockerfile né file Docker Compose
- Ha un modello di pull request
- Leggi la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di GenericMappingTools/pygmt
-
Improve reporting the GMT version via "pygmt.show_versions()"Forse già presa @yvonnefroehlich l’ha presa 63 giorni fa. Apertamaintenance
Difficoltà 2/5 1-3 ore Idoneità per principianti 68/100
GenericMappingTools/pygmt#4812 · 4 commenti ·
I maintainer di solito rispondono entro 1 giorno
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 64/100
GenericMappingTools/pygmt#4765 ·
I maintainer di solito rispondono entro 1 giorno
-
Add an AGENTS.md fileForse già presa Una pull request collegata a questa issue è aperta o già unita. Apertadiscussions
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
GenericMappingTools/pygmt#4677 · 2 commenti · 1 reazione ·
I maintainer di solito rispondono entro 1 giorno
-
documentation help wanted
Difficoltà 3/5 1-2 giorni Idoneità per principianti 68/100
GenericMappingTools/pygmt#4905 · 1 reazione ·
I maintainer di solito rispondono entro 1 giorno
-
Pythonic implementation for the "series" parameter that accept xmin/xmax/inc and comma-separated sequenceForse già presa Una pull request collegata a questa issue è aperta o già unita. Apertadiscussions feature request
Difficoltà 4/5 3-5 giorni Idoneità per principianti 67/100
GenericMappingTools/pygmt#4898 ·
I maintainer di solito rispondono entro 1 giorno
Tutte le issue di GenericMappingTools/pygmt
Issue simili
-
bug difficulty:2 good first issue help wanted
Difficoltà 2/5 1-3 ore Idoneità per principianti 88/100
MakazhanAlpamys/Soup#1865 ·
I maintainer di solito rispondono entro 1 giorno
-
area: agents area: docs good first issue
Difficoltà 2/5 1-3 ore Idoneità per principianti 88/100
openapi/gknowledge#23 ·
-
useless-suppression reported for deprecated-* messages that should be exemptForse già presa @adityasinha-ghub l’ha presa oggi. Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 88/100
pylint-dev/pylint#11656 ·
I maintainer di solito rispondono entro 1 giorno
-
area:provisioning effort:S priority:P2 provider:local-libvirt risk:daytime-only status:in-progress type:bug
Difficoltà 2/5 1-3 ore Idoneità per principianti 78/100
randomparity/kdive#3203 · 2 commenti ·
I maintainer di solito rispondono entro 1 giorno
-
get() for StrEnumForse già presa @FeJo5952 l’ha presa oggi. Apertagood first issue
Difficoltà 2/5 1-3 ore Idoneità per principianti 72/100
collective/icalendar#1921 · 1 commento ·
I maintainer di solito rispondono entro 1 giorno