Skip to content

Commit e4456de

Browse files
committed
Update
1 parent ec446a7 commit e4456de

File tree

7 files changed

+92
-7
lines changed

7 files changed

+92
-7
lines changed

.github/docs_config/Doxyfile

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
# Core Docs Configuration
2+
PROJECT_NAME = "Plugin Frame"
3+
PROJECT_LOGO = ./assets/wordpress-logo.png
4+
OUTPUT_DIRECTORY = public
5+
INPUT = app
6+
FILE_PATTERNS = *.php
7+
8+
# DocBlock Standards
9+
ALIASES = "since=@since"
10+
ALIASES += "see=@see"
11+
ALIASES += "link=@link"
12+
ALIASES += "global=@global"
13+
ALIASES += "action=@action"
14+
ALIASES += "filter=@filter"
15+
ALIASES += "hook=@hook"
16+
ALIASES += "shortcode=@shortcode"
17+
18+
# HTML Output
19+
HTML_OUTPUT = .
20+
HTML_HEADER = docs-header.html
21+
HTML_FOOTER = footer.html
22+
HTML_STYLESHEET = pf-docs.css
23+
GENERATE_TREEVIEW = YES
24+
USE_MDFILE_AS_MAINPAGE = README.md
25+
26+
# Diagrams & Search
27+
HAVE_DOT = YES
28+
CLASS_GRAPH = YES
29+
CALL_GRAPH = YES
30+
SEARCHENGINE = YES
31+
32+
# WordPress Doc Behavior
33+
EXTRACT_ALL = YES
34+
EXTRACT_PRIVATE = YES
35+
WARN_IF_UNDOCUMENTED = YES
36+
37+
# Paths relative to project root
38+
PROJECT_LOGO = public/assets/pf-logo.png
39+
HTML_HEADER = public/docs-header.html
40+
HTML_STYLESHEET = public/pf-docs.css

.github/docs_config/assets/pf-logo.png

Loading
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
<div class="wp-docs-header">
2+
<img src="pf-logo.png" alt="WordPress" width="32" height="32">
3+
<h1>Plugin Frame Documentation</h1>
4+
<div class="wp-search-form">
5+
<input type="search" placeholder="Search documentation...">
6+
</div>
7+
</div>

.github/docs_config/pf-docs.css

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
/* WordPress-like documentation styles */
2+
body {
3+
font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen-Sans, Ubuntu, Cantarell, "Helvetica Neue", sans-serif;
4+
color: #1e1e1e;
5+
}
6+
7+
.wp-docs-header {
8+
background: #f0f0f1;
9+
padding: 2rem;
10+
border-bottom: 3px solid #3858e9;
11+
}
12+
13+
.wp-docs-footer {
14+
margin-top: 4rem;
15+
padding: 2rem;
16+
background: #f0f0f1;
17+
text-align: center;
18+
}
19+
20+
/* Match WordPress code blocks */
21+
code {
22+
background: #f0f0f1;
23+
padding: 2px 4px;
24+
border-radius: 4px;
25+
}

.github/workflows/docs.yml

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: Documentation Deployment
1+
name: WordPress Docs Deployment
22
on:
33
push:
44
branches: [master]
@@ -10,23 +10,36 @@ jobs:
1010
- name: Checkout code
1111
uses: actions/checkout@v4
1212

13-
- name: Install Dependencies
13+
- name: Setup Environment
1414
run: |
1515
sudo apt-get update
1616
sudo apt-get install -y doxygen graphviz
17+
mkdir -p public public/assets
18+
19+
- name: Copy Config Files
20+
run: |
21+
# Copy Doxygen config to root
22+
cp .github/docs_config/Doxyfile ./Doxyfile
23+
# Copy styling assets
24+
cp .github/docs_config/docs-header.html public/
25+
cp .github/docs_config/wordpress-docs.css public/
26+
cp .github/docs_config/assets/* public/assets/
1727
1828
- name: Generate Documentation
1929
run: |
20-
mkdir -p public
21-
echo "pf.ractstudio.com" > public/CNAME # Add CNAME file
30+
echo "pf.ractstudio.com" > public/CNAME
2231
doxygen Doxyfile
32+
# Add WordPress footer
33+
echo '<div class="wp-docs-footer">Documentation follows <a href="https://developer.wordpress.org/coding-standards/">WordPress standards</a></div>' >> public/footer.html
2334
35+
- name: Cleanup & Deploy
36+
run: rm Doxyfile # Remove temporary file
37+
2438
- name: Deploy to Doc Branch
2539
uses: peaceiris/actions-gh-pages@v3
2640
with:
2741
github_token: ${{ secrets.GITHUB_TOKEN }}
2842
publish_dir: ./public
29-
destination_dir: .
3043
publish_branch: doc
31-
keep_files: true # Preserve existing files
32-
force_orphan: false # Disable orphan branch reset
44+
keep_files: true
45+
force_orphan: false

.github/workflows/docs.yml.old

Whitespace-only changes.
File renamed without changes.

0 commit comments

Comments
 (0)