Skip to content

Commit f543c96

Browse files
committed
Update
1 parent e4456de commit f543c96

File tree

6 files changed

+47
-18
lines changed

6 files changed

+47
-18
lines changed

.github/docs_config/Doxyfile

Lines changed: 7 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Core Docs Configuration
22
PROJECT_NAME = "Plugin Frame"
3-
PROJECT_LOGO = ./assets/wordpress-logo.png
3+
PROJECT_LOGO = ./assets/pf-logo.png
44
OUTPUT_DIRECTORY = public
5-
INPUT = app
5+
INPUT =
66
FILE_PATTERNS = *.php
77

88
# DocBlock Standards
@@ -17,9 +17,10 @@ ALIASES += "shortcode=@shortcode"
1717

1818
# HTML Output
1919
HTML_OUTPUT = .
20-
HTML_HEADER = docs-header.html
20+
PF_LOGO = public/assets/pf-logo.png
21+
HTML_HEADER = header.html
2122
HTML_FOOTER = footer.html
22-
HTML_STYLESHEET = pf-docs.css
23+
HTML_STYLESHEET = public/assets/pf-style.css
2324
GENERATE_TREEVIEW = YES
2425
USE_MDFILE_AS_MAINPAGE = README.md
2526

@@ -29,12 +30,7 @@ CLASS_GRAPH = YES
2930
CALL_GRAPH = YES
3031
SEARCHENGINE = YES
3132

32-
# WordPress Doc Behavior
33+
# Doc Behavior
3334
EXTRACT_ALL = YES
3435
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
36+
WARN_IF_UNDOCUMENTED = YES

.github/docs_config/footer.html

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
<div class="wp-docs-footer">
2+
Documentation follows <a href="https://developer.wordpress.org/coding-standards/">WordPress standards</a>
3+
</div>

.github/workflows/docs.yml

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
name: WordPress Docs Deployment
1+
name: Plugin Frame Docs Deployment
22
on:
33
push:
44
branches: [master]
@@ -19,18 +19,16 @@ jobs:
1919
- name: Copy Config Files
2020
run: |
2121
# Copy Doxygen config to root
22-
cp .github/docs_config/Doxyfile ./Doxyfile
22+
cp ./docs_config/Doxyfile ./Doxyfile
2323
# 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/
24+
cp ./docs_config/header.html public/
25+
cp ./docs_config/footer.html public/
26+
cp ./docs_config/assets/* public/assets/
2727
2828
- name: Generate Documentation
2929
run: |
3030
echo "pf.ractstudio.com" > public/CNAME
3131
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
3432
3533
- name: Cleanup & Deploy
3634
run: rm Doxyfile # Remove temporary file

.github/workflows/docs.yml.old

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Plugin Frame Docs Deployment
2+
on:
3+
push:
4+
branches: [master]
5+
6+
jobs:
7+
build-docs:
8+
runs-on: ubuntu-latest
9+
steps:
10+
- name: Checkout code
11+
uses: actions/checkout@v4
12+
13+
- name: Install Dependencies
14+
run: |
15+
sudo apt-get update
16+
sudo apt-get install -y doxygen graphviz
17+
18+
- name: Generate Documentation
19+
run: |
20+
mkdir -p public
21+
echo "pf.ractstudio.com" > public/CNAME # Add CNAME file
22+
doxygen Doxyfile
23+
24+
- name: Deploy to Doc Branch
25+
uses: peaceiris/actions-gh-pages@v3
26+
with:
27+
github_token: ${{ secrets.GITHUB_TOKEN }}
28+
publish_dir: ./public
29+
destination_dir: .
30+
publish_branch: doc
31+
keep_files: true # Preserve existing files
32+
force_orphan: false # Disable orphan branch reset

0 commit comments

Comments
 (0)