openPMD/openPMD-api

Sphinx: C++/Py Side-By-Side

Offen

#62 geöffnet am 13.02.2018

Auf GitHub ansehenContributor Guide
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)C++ (57 Forks)auto 404
documentationgood first issuehelp wanted

Repository-Metriken

Stars
 (160 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

We should add a little CSS hack in docs/source/_static/ that layouts directly following C++ and Python code blocks side-by-side.

Depends on

  • #32

Contributor Guide

Research-Richtung
Baue die Dokumentation lokal mit Sphinx. Untersuche das vorhandene CSS in docs/source/ static/. Verstehe, wie Codeblöcke erzeugt werden, und füge eine CSS Regel hinzu, um benachbarte C++ und Python Codeblöcke nebeneinander anzuzeigen.
Tech Stack
css
Domain
documentation
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Blockiert
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
GitCSSSphinx
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75