Skip to content

Commit dfdccfc

Browse files
luisleo526claude
luisleo526
and
claude
authored
docs: a 404 page, per-page descriptions and a product link in the theme (#380, part a) (#390)
Part a of #380 (EN-94), split by ENGINE-TOP and L6 so the theme lands first. This part is the documentation theme only: - the page footers link https://pineforge.dev (both footer branches); - docs/_theme/404.html is copied to the site root through HTML_EXTRA_FILES in docs/Doxyfile; - the page template's meta description is built from each page's title instead of one sentence on every page. Part b (docs/build.sh, docs/seo_postprocess.py, scripts/ci_docs_only.py, scripts/test_ci_docs_only.py, tests/CMakeLists.txt, and with them docs/_theme/robots.txt, the robots.txt line of docs/Doxyfile and docs/ci.md) adds the canonical URLs, the sitemap, robots.txt, the version label and the self-test. robots.txt moves with it because it names the sitemap that only part b generates. Co-authored-by: Claude Sonnet 5.5 <[email protected]>
1 parent 04607c1 commit dfdccfc

4 files changed

Lines changed: 27 additions & 2 deletions

File tree

‎docs/Doxyfile‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -201,7 +201,8 @@ HTML_EXTRA_FILES = _theme/doxygen-awesome/doxygen-awesome-darkmode-toggle.
201201
_theme/doxygen-awesome/doxygen-awesome-fragment-copy-button.js \
202202
_theme/doxygen-awesome/doxygen-awesome-paragraph-link.js \
203203
_theme/doxygen-awesome/doxygen-awesome-interactive-toc.js \
204-
_theme/doxygen-awesome/doxygen-awesome-tabs.js
204+
_theme/doxygen-awesome/doxygen-awesome-tabs.js \
205+
_theme/404.html
205206
HTML_COLORSTYLE = LIGHT
206207
HTML_COLORSTYLE_HUE = 209
207208
HTML_COLORSTYLE_SAT = 255

‎docs/_theme/404.html‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
<!DOCTYPE html>
2+
<html lang="en" class="light-mode">
3+
<head>
4+
<meta charset="utf-8"/>
5+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
6+
<title>Page not found</title>
7+
<link rel="stylesheet" href="/doxygen-awesome.css"/>
8+
<link rel="stylesheet" href="/custom.css"/>
9+
<style>
10+
body { margin: 0; background: var(--page-background-color, #fff); color: var(--page-foreground-color, #2c2c2c); font-family: var(--font-family, sans-serif); line-height: 1.65; }
11+
main { max-width: 42rem; margin: 5rem auto; padding: 0 1.5rem; }
12+
a { color: var(--primary-color, #1565c0); }
13+
</style>
14+
</head>
15+
<body>
16+
<main>
17+
<h1>Page not found</h1>
18+
<p>The requested documentation page could not be found.</p>
19+
<p><a href="/">API reference</a> &mdash; <a href="https://pineforge.dev">pineforge.dev</a></p>
20+
</main>
21+
</body>
22+
</html>

‎docs/_theme/footer.html‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
PineForge $projectnumber
99
&mdash; Apache-2.0
1010
&mdash; <a href="https://github.com/pineforge-4pass/pineforge-engine">github.com/pineforge-4pass/pineforge-engine</a>
11+
&mdash; <a href="https://pineforge.dev">pineforge.dev</a>
1112
</li>
1213
</ul>
1314
</div>
@@ -16,6 +17,7 @@
1617
<hr class="footer"/><address class="footer"><small>
1718
PineForge $projectnumber &mdash; Apache-2.0 &mdash;
1819
<a href="https://github.com/pineforge-4pass/pineforge-engine">source on GitHub</a>
20+
&mdash; <a href="https://pineforge.dev">pineforge.dev</a>
1921
</small></address>
2022
</div><!-- doc-content -->
2123
<!--END !GENERATE_TREEVIEW-->

‎docs/_theme/header.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
2424
<meta name="generator" content="Doxygen $doxygenversion"/>
2525
<meta name="viewport" content="width=device-width, initial-scale=1"/>
26-
<meta name="description" content="PineForge runtime — public C ABI reference. Deterministic PineScript v6 backtest engine, validated trade-for-trade against TradingView."/>
26+
<meta name="description" content="$title — PineForge C++17 engine API documentation."/>
2727
<!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME-->
2828
<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
2929
<!--BEGIN PROJECT_ICON-->

0 commit comments

Comments
 (0)