matplotlib / matplotlib/grid-strategy
Use matplotlib sphinx extensions to build documentation
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 44
- Forks
- 16
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
We should have a few simple examples in the documentation, generated inline with the matplotlib plotting extensions for sphinx.
For example, we can use this to generate one of the main figures:
.. plot::
import matplotlib.pyplot as plt
from grid_strategy.strategies import SquareStrategy
specs = SquareStrategy('center').get_grid(7)
for i, spec in enumerate(specs):
ax = plt.subplot(spec)
ax.text(0.5, 0.5, f"Subplot: {i}", color='white',
fontweight='bold', va="center", ha="center")
ax.tick_params(axis='both', bottom=False, top=False, left=False,
right=False, labelbottom=False, labelleft=False)
ax.patch.set_facecolor('#2E2E2E')
plt.show()
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Finde die Sphinx-Dokumentationskonfiguration und den Einstiegspunkt der Dokumentation und verwende dann das gezeigte SquareStrategy-Beispiel als Ausgangsfall. Als abgeschlossen gilt die Aufgabe, wenn die ausgewählten Beispiele in der generierten Dokumentation als Inline-Matplotlib-Plots erstellt werden.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- matplotlib, python
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 3/5
- Geschätzter Aufwand
- 1-2 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 42/100