python / python/python-docs-theme
Improving readability of documentation tables
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- CSS
- Estrellas
- 90
- Forks
- 78
- Merge medio
- 2 d 19 h
- PR fusionados (30 d)
- 4
Descripción
Documentation
I was reading through the documentation and I thought of a way you could make it read better.
You could do the thing thats done with tables where you alternate the background color to make the elements easier to distinguish at a glance.
I made a quick example using inspect element to color every other method in the documentation.
vs what it looks like currently.
My quick test was done by adding
.py.method:nth-child(odd) {
background-color: #2d2d2d;
}
And replacing the margin on the dl elements with padding so the background color would fill it.
I originally used dl:nth-child(odd) but .py.method:nth-child(odd) worked better, but it would probably be better to add a new class to the elements you want highlight instead, because dl:nth-child(odd) highlights too much and .py.method:nth-child(odd) doesnt highlight all of the elements you would probably want highlighted.
*:is(.py.method, .describe):nth-child(odd of *:is(.py.method, .describe)) {
background-color: #2b2b2b;
}
Should work but adding a new class is probably easier to maintain and you could reuse it in more places.
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza localizando el CSS y el marcado del tema de documentación mediante los selectores .py.method y .describe mencionados en el issue. Compara el estilo actual de la tabla con los ejemplos proporcionados y verifica después que los fondos alternos y el espaciado ajustado mejoren la legibilidad sin resaltar elementos no intencionados.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- css
- Área
- design, documentation
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Tranquilo
- Claridad
- Bastante claro
- Aptitud para principiantes
- 55/100