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.

貢獻指南

開啟貢獻指南

研究方向

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.

由索引模型根據 Issue 內容生成。

評估

領域
build-system, documentation
Issue 類型
文件
難度
5/5
預估耗時
一週以上
活躍度
停滯
描述清晰度
需要釐清
新手友好度
25/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。