Skip to content

Commit 6268807

Browse files
committed
Docs: try auto-generation of docblock files
1 parent 0952283 commit 6268807

File tree

147 files changed

+8980
-282
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

147 files changed

+8980
-282
lines changed

.github/workflows/phpcs.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ jobs:
1414
- name: Setup PHP
1515
uses: shivammathur/setup-php@v2
1616
with:
17-
php-version: '8.1'
17+
php-version: '8.4'
1818
tools: composer:v2
1919

2020
- name: Install Dependencies

.markdownlint.json

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
{
2+
"default": true,
3+
"MD013": false,
4+
"MD024": false,
5+
"MD033": {
6+
"allowed_elements": [
7+
"br",
8+
"img",
9+
"video",
10+
"details",
11+
"summary"
12+
]
13+
},
14+
"no-inline-html": {
15+
"allowed_elements": [
16+
"br",
17+
"kbd",
18+
"sup"
19+
]
20+
},
21+
"first-line-h1": false,
22+
"commands-show-output": false,
23+
"code-block-style": false,
24+
"no-duplicate-heading": {
25+
"siblings_only": true
26+
},
27+
"no-trailing-punctuation": {
28+
"punctuation": ".,;:!"
29+
},
30+
"ol-prefix": {
31+
"style": "ordered"
32+
},
33+
"fenced-code-language": true,
34+
"ignores": [
35+
"vendor/**",
36+
"node_modules/**"
37+
]
38+
}

composer.json

+13-5
Original file line numberDiff line numberDiff line change
@@ -16,14 +16,22 @@
1616
"require-dev": {
1717
"wp-coding-standards/wpcs": "^3.0",
1818
"phpcompatibility/phpcompatibility-wp": "^2.1",
19-
"sirbrillig/phpcs-changed": "^2.11"
19+
"sirbrillig/phpcs-changed": "^2.11",
20+
"nikic/php-parser": "^4.0",
21+
"symfony/finder": "^5.0|^6.0"
2022
},
2123
"scripts": {
22-
"docs-manifest": "php docs/bin/generate-manifest.php",
23-
"docs-links": "php docs/bin/update-markdown-links.php",
24+
"docs:manifest": "php docs/bin/generate-manifest.php",
25+
"docs:links": "php docs/bin/update-markdown-links.php",
26+
"docs:parse": "php docs/bin/generate-parsed-md.php --output=${DOCS_OUTPUT_DIR:-docs/code-reference}",
27+
"docs:fix": "npm run fix:md",
28+
"docs:lint": "npm run lint:md",
2429
"docs": [
25-
"@docs-links",
26-
"@docs-manifest"
30+
"@docs:parse",
31+
"@docs:links",
32+
"@docs:fix",
33+
"@docs:lint",
34+
"@docs:manifest"
2735
]
2836
}
2937
}

composer.lock

+121-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)