openPMD/openPMD-api

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

Ouverte

#62 ouverte le 13 févr. 2018

Voir sur GitHubGuide contributeur
 (0 commentaire) (0 réaction) (0 personne assignée)C++ (57 forks)auto 404
documentationgood first issuehelp wanted

Métriques du dépôt

Stars
 (160 étoiles)
Métriques de merge PR
 (Métriques PR en attente)

Description

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

Guide contributeur

Direction de recherche
Construisez la documentation localement avec Sphinx. Examinez le CSS existant dans docs/source/ static/. Comprenez comment les blocs de code sont générés et ajoutez une règle CSS pour afficher les blocs de code C++ et Python adjacents côte à côte.
Stack technique
css
Domaine
documentation
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Bloquée
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
GitCSSSphinx
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75