From c57b9cb5f90ab80188df4f45428225243b51dce9 Mon Sep 17 00:00:00 2001
From: Sean O'Brien <60306702+stobrien89@users.noreply.github.com>
Date: Wed, 26 Jun 2024 11:44:35 -0400
Subject: [PATCH] enhancement: api docs accessibility updates (#2946)
---
build/docs/.phpdoc/template/base.html.twig | 2 +-
.../template/components/back-to-top.html.twig | 1 +
.../template/components/header.html.twig | 9 +
.../template/components/headerlink.html.twig | 1 +
.../template/components/menu.html.twig | 15 ++
.../components/search-results.html.twig | 2 +-
.../template/components/sidebar.css.twig | 103 ++++++++
.../template/components/sidebar.html.twig | 2 +-
.../table-of-contents-entry.html.twig | 12 +
.../template/components/topnav.html.twig | 2 +-
build/docs/.phpdoc/template/css/base.css.twig | 37 ++-
build/docs/classes/DocsBuilder.php | 15 +-
build/docs/classes/HtmlDocument.php | 2 +-
.../static/glyphicons-halflings-regular.eot | Bin 0 -> 20335 bytes
.../static/glyphicons-halflings-regular.svg | 229 ++++++++++++++++++
.../static/glyphicons-halflings-regular.ttf | Bin 0 -> 41280 bytes
.../static/glyphicons-halflings-regular.woff | Bin 0 -> 23320 bytes
17 files changed, 412 insertions(+), 20 deletions(-)
create mode 100644 build/docs/.phpdoc/template/components/back-to-top.html.twig
create mode 100644 build/docs/.phpdoc/template/components/header.html.twig
create mode 100644 build/docs/.phpdoc/template/components/headerlink.html.twig
create mode 100644 build/docs/.phpdoc/template/components/menu.html.twig
create mode 100644 build/docs/.phpdoc/template/components/sidebar.css.twig
create mode 100644 build/docs/.phpdoc/template/components/table-of-contents-entry.html.twig
create mode 100644 build/docs/static/glyphicons-halflings-regular.eot
create mode 100644 build/docs/static/glyphicons-halflings-regular.svg
create mode 100644 build/docs/static/glyphicons-halflings-regular.ttf
create mode 100644 build/docs/static/glyphicons-halflings-regular.woff
diff --git a/build/docs/.phpdoc/template/base.html.twig b/build/docs/.phpdoc/template/base.html.twig
index 2b52d856da..fd689a628e 100644
--- a/build/docs/.phpdoc/template/base.html.twig
+++ b/build/docs/.phpdoc/template/base.html.twig
@@ -7,7 +7,7 @@
{ "name": "Submit Feedback", "url": "https://docs-feedback.aws.amazon.com/feedback.jsp?hidden_service_name=AWS%20SDK%20for%20PHP"},
],
"social": [
- { "iconClass": "fab fa-github", "url": "https://github.com/aws/aws-sdk-php"},
+ { "accessiblename": "GitHub Link", "iconClass": "fab fa-github", "url": "https://github.com/aws/aws-sdk-php"},
]
}
%}
diff --git a/build/docs/.phpdoc/template/components/back-to-top.html.twig b/build/docs/.phpdoc/template/components/back-to-top.html.twig
new file mode 100644
index 0000000000..1d67dc8e60
--- /dev/null
+++ b/build/docs/.phpdoc/template/components/back-to-top.html.twig
@@ -0,0 +1 @@
+
diff --git a/build/docs/.phpdoc/template/components/header.html.twig b/build/docs/.phpdoc/template/components/header.html.twig
new file mode 100644
index 0000000000..e1d02fe48c
--- /dev/null
+++ b/build/docs/.phpdoc/template/components/header.html.twig
@@ -0,0 +1,9 @@
+
\ No newline at end of file
diff --git a/build/docs/.phpdoc/template/components/headerlink.html.twig b/build/docs/.phpdoc/template/components/headerlink.html.twig
new file mode 100644
index 0000000000..5818497811
--- /dev/null
+++ b/build/docs/.phpdoc/template/components/headerlink.html.twig
@@ -0,0 +1 @@
+
\ No newline at end of file
diff --git a/build/docs/.phpdoc/template/components/menu.html.twig b/build/docs/.phpdoc/template/components/menu.html.twig
new file mode 100644
index 0000000000..3b16020ab8
--- /dev/null
+++ b/build/docs/.phpdoc/template/components/menu.html.twig
@@ -0,0 +1,15 @@
+{% if depth == 1 %}
+
+{% endif %}
+{% if entry.children.count > 0 %}
+
+ {% for child in entry.children %}
+ -
+ {{ child.title | shortFQSEN }}
+ {{ toc(child, 'components/menu.html.twig', maxDepth, depth) }}
+
+ {% endfor %}
+
+{% endif %}
\ No newline at end of file
diff --git a/build/docs/.phpdoc/template/components/search-results.html.twig b/build/docs/.phpdoc/template/components/search-results.html.twig
index f388e48fa2..a1a46f487c 100644
--- a/build/docs/.phpdoc/template/components/search-results.html.twig
+++ b/build/docs/.phpdoc/template/components/search-results.html.twig
@@ -1,7 +1,7 @@
diff --git a/build/docs/.phpdoc/template/components/sidebar.css.twig b/build/docs/.phpdoc/template/components/sidebar.css.twig
new file mode 100644
index 0000000000..23995c1748
--- /dev/null
+++ b/build/docs/.phpdoc/template/components/sidebar.css.twig
@@ -0,0 +1,103 @@
+.phpdocumentor-sidebar {
+ margin: 0;
+ overflow: hidden;
+ max-height: 0;
+}
+
+.phpdocumentor .phpdocumentor-sidebar .phpdocumentor-list {
+ padding: var(--spacing-xs) var(--spacing-md);
+ list-style: none;
+ margin: 0;
+}
+
+.phpdocumentor .phpdocumentor-sidebar li {
+ white-space: nowrap;
+ text-overflow: ellipsis;
+ overflow: hidden;
+ padding: 0 0 var(--spacing-xxxs) var(--spacing-md);
+}
+
+.phpdocumentor .phpdocumentor-sidebar abbr,
+.phpdocumentor .phpdocumentor-sidebar a {
+ text-decoration: none;
+ border-bottom: none;
+ color: var(--text-color);
+ font-size: var(--text-md);
+ padding-left: 0;
+ transition: padding-left .4s ease-out;
+}
+
+.phpdocumentor .phpdocumentor-sidebar a:hover,
+.phpdocumentor .phpdocumentor-sidebar a.-active {
+ padding-left: 5px;
+ font-weight: 600;
+}
+
+.phpdocumentor .phpdocumentor-sidebar__category > * {
+ border-left: 1px solid var(--primary-color-lighten);
+}
+
+.phpdocumentor .phpdocumentor-sidebar__category {
+ margin-bottom: var(--spacing-lg);
+}
+
+.phpdocumentor .phpdocumentor-sidebar__category-header {
+ font-size: var(--text-md);
+ margin-top: 0;
+ margin-bottom: var(--spacing-xs);
+ color: var(--link-color-primary);
+ font-weight: 600;
+ border-left: 0;
+}
+
+.phpdocumentor .phpdocumentor-sidebar__root-package,
+.phpdocumentor .phpdocumentor-sidebar__root-namespace {
+ font-size: var(--text-md);
+ margin: 0;
+ padding-top: var(--spacing-xs);
+ padding-left: var(--spacing-md);
+ color: var(--text-color);
+ font-weight: normal;
+}
+
+@media (min-width: {{ breakpoints['md'] }}) {
+ .phpdocumentor-sidebar {
+ border-right: var(--sidebar-border-color) solid 1px;
+ }
+}
+
+.phpdocumentor-sidebar__menu-button {
+ position: absolute;
+ top: -100%;
+ left: -100%;
+}
+
+.phpdocumentor-sidebar__menu-icon {
+ font-size: var(--text-md);
+ font-weight: 600;
+ background: var(--primary-color-darker);
+ color: white;
+ margin: 0 0 var(--spacing-lg);
+ display: block;
+ padding: var(--spacing-sm);
+ text-align: center;
+ border-radius: 3px;
+ text-transform: uppercase;
+ letter-spacing: .15rem;
+}
+
+.phpdocumentor-sidebar__menu-button:checked ~ .phpdocumentor-sidebar {
+ max-height: 100%;
+ padding-top: var(--spacing-md);
+}
+
+@media (min-width: {{ breakpoints['md'] }}) {
+ .phpdocumentor-sidebar {
+ overflow: visible;
+ max-height: 100%;
+ }
+
+ .phpdocumentor-sidebar__menu-icon {
+ display: none;
+ }
+}
\ No newline at end of file
diff --git a/build/docs/.phpdoc/template/components/sidebar.html.twig b/build/docs/.phpdoc/template/components/sidebar.html.twig
index 5d49996db0..84aeafc611 100644
--- a/build/docs/.phpdoc/template/components/sidebar.html.twig
+++ b/build/docs/.phpdoc/template/components/sidebar.html.twig
@@ -1,4 +1,4 @@
-
+
diff --git a/build/docs/.phpdoc/template/components/table-of-contents-entry.html.twig b/build/docs/.phpdoc/template/components/table-of-contents-entry.html.twig
new file mode 100644
index 0000000000..ea38d31ca6
--- /dev/null
+++ b/build/docs/.phpdoc/template/components/table-of-contents-entry.html.twig
@@ -0,0 +1,12 @@
+
+ {{ node is property ? '$' }}{{ node.name }}{{ node is method or node is function ? '()' }}
+
+ {% if node is constant %} = {{ node.value }}{% endif %}
+ {% if node is enumCase %}{% if node.value %} = {{ node.value }}{% endif %}{% endif %}
+ {% if node is property %} : {{ node.type ? node.type|route('class:short')|join('|')|raw : 'mixed' }}{% endif %}
+ {% if node is method or node is function %} : {{ node.response.type|route('class:short')|join('|')|raw }}{% endif %}
+
+
+{% if node.summary %}
+ {{ node.summary }}
+{% endif %}
\ No newline at end of file
diff --git a/build/docs/.phpdoc/template/components/topnav.html.twig b/build/docs/.phpdoc/template/components/topnav.html.twig
index fc8e5c678c..5326ad96eb 100644
--- a/build/docs/.phpdoc/template/components/topnav.html.twig
+++ b/build/docs/.phpdoc/template/components/topnav.html.twig
@@ -3,7 +3,7 @@
{% for key,menu in topMenu|default([]) %}
{% for menuitem in menu %}