openPMD/openPMD-api

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

Open

#62 opened on Feb 13, 2018

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)C++ (57 forks)auto 404
documentationgood first issuehelp wanted

Repository metrics

Stars
 (160 stars)
PR merge metrics
 (PR metrics pending)

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

Contributor guide

Research direction
Build the docs locally with Sphinx. Examine the existing CSS in docs/source/ static/. Understand how code blocks are generated and add a CSS rule to display adjacent C++ and Python code blocks side by side.
Tech stack
css
Domain
documentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitCSSSphinx
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75