openPMD/openPMD-api

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

Aberta

#62 aberto em 13 de fev. de 2018

Ver no GitHubGuia do colaborador
 (0 comentário) (0 reação) (0 responsável)C++ (57 forks)auto 404
documentationgood first issuehelp wanted

Métricas do repositório

Stars
 (160 estrelas)
Métricas de merge de PR
 (Métricas PR pendentes)

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

Guia do colaborador

Direção de pesquisa
Compile a documentação localmente com Sphinx. Examine o CSS existente em docs/source/ static/. Entenda como os blocos de código são gerados e adicione uma regra CSS para exibir blocos de código C++ e Python adjacentes lado a lado.
Pilha de tecnologia
css
Domain
documentation
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Bloqueado
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
GitCSSSphinx
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75