check_module_name.ps1 ダウンロード/コピー

check_module_name.ps1 をダウンロード

check_module_name.ps1
check_module_name.ps1
 1<#
 2"""
 3概要:
 4    Sphinxドキュメント構造のチェックを行うPowerShellスクリプトです。
 5詳細説明:
 6    このスクリプトは、Sphinxプロジェクトのドキュメント構造における一般的な問題（indexファイルの命名規則違反、
 7    古い参照、toctreeにおける拡張子記述ミスなど）を検出することを目的としています。
 8主な機能:
 9    indexファイルの存在と命名規則をチェックします。
10    古いハイフン命名スタイルでの参照がtoctree内に残っていないか確認します。
11    toctree内でファイル名に拡張子（.rstや.md）が誤って記述されている箇所を検出します。
12関連リンク:
13    check_module_name_usage
14"""
15#>
16# PowerShellがスクリプト実効を禁止していたら、以下を実行する
17#Set-ExecutionPolicy -Scope CurrentUser RemoteSigned
18
19# ============================================
20# Sphinx ドキュメント構造チェック用スクリプト
21# ============================================
22
23<#
24"""
25概要:
26    indexファイルの一覧をチェックします。
27詳細説明:
28    このセクションでは、Sphinxドキュメントプロジェクト内のindexファイルの存在確認、
29    命名規則（-_混在など）のチェック、および想定外のファイル混入の検出を行います。
30"""
31#>
32# --------------------------------------------
33# 1. *_index.rst / *_index.md ファイル一覧
34# --------------------------------------------
35# 目的：
36# - indexファイルの存在確認
37# - 命名規則（-_混在など）のチェック
38# - 想定外のファイル混入の検出
39# --------------------------------------------
40
41Write-Host "=== Index files check ==="
42
43Get-ChildItem source\cms -Recurse |
44    Where-Object { $_.Name -match '[-_].*_index\.(rst|md)$' } |
45    Select-Object FullName
46
47<#
48"""
49概要:
50    古いハイフン命名スタイルの参照をチェックします。
51詳細説明:
52    このセクションでは、toctree内に残っている古い参照（ハイフン版）を検出します。
53    これは、Sphinxのmultiple toctrees warning の原因調査に役立ちます。
54"""
55#>
56# --------------------------------------------
57# 2. 古いハイフン命名の参照チェック
58# --------------------------------------------
59# 目的：
60# - toctree内に残っている古い参照（-版）を検出
61# - multiple toctrees warning の原因調査
62# --------------------------------------------
63
64Write-Host "`n=== Old hyphen-style reference check ==="
65
66Get-ChildItem source -Recurse -Include *.rst, *.md |
67    Select-String -Pattern "N-integration-metal|smoothing-fft"
68
69<#
70"""
71概要:
72    toctreeのファイル名に拡張子が書かれているファイルを検出します。
73詳細説明:
74    このセクションでは、toctree内でファイル名に .rst や .md といった拡張子が
75    誤って記述されている箇所を検出します。
76"""
77#>
78# --------------------------------------------
79# 3. toctreeのファイル名に.rstや.mdを書いているファイルを検出
80# --------------------------------------------
81
82Write-Host "`n=== .rst extension usage check ==="
83
84Get-ChildItem source -Recurse -Include *.rst, *.md | Select-String -Pattern "\.rst>"
85
86# --------------------------------------------
87# 終了メッセージ
88# --------------------------------------------
89
90Write-Host "`nCheck completed."