DiamondLightSource / DiamondLightSource/python-copier-template
Standardisation of sphinx docs page titles
- Lenguaje dominante
- Jinja
- Estrellas
- 25
- Forks
- 10
- Merge medio
- 4 h 4 min
- PR fusionados (30 d)
- 6
Descripción
This may be the nitpickiest issue I have ever raised, so should not be actioned unless there's strong agreement.

(from https://diamondlightsource.github.io/python-copier-template/main/how-to.html)
It annoys me that the titles for docs pages are not really standardised, Some Are Capitalised, some are not, some are prefixed with "How to" or similar. If there is a really easy check that can be added to the docs builds it might add a layer of consistency and professionalism. The hardest part, as ever when we talk about formatting, may be agreeing on which standard to use.
Guía de contribución
Línea de trabajo
Review the example page at https://diamondlightsource.github.io/python-copier-template/main/how-to.html and the issue discussion first, since no source file or test is named. Confirm that the project has agreed on a title convention and identify the docs build entry point before scoping a check; done means the convention is explicit and the build consistently enforces it.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Área
- build-system, documentation
- Tipo de issue
- Documentación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Estado de actividad
- Estancado
- Claridad
- Necesita aclaración
- Aptitud para principiantes
- 25/100