DiamondLightSource / DiamondLightSource/python-copier-template

Standardisation of sphinx docs page titles

未关闭
#232 14 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
enhancement
主要语言
Jinja
星标
25
派生
10
平均合并
4 小时 4 分钟
30 天内合并 PR
6

描述

This may be the nitpickiest issue I have ever raised, so should not be actioned unless there's strong agreement.

![Image](https://github.com/user-attachments/assets/a1729ee3-5e8e-4789-b686-dca7b6d64ba0)
(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.

贡献指南

打开贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。