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 @@ +
+ {% include 'components/header-title.html.twig' %} + + + {{ include('components/search.html.twig') }} + {% include 'components/topnav.html.twig' %} +
\ 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 %} +

+ {{ entry.title | shortFQSEN }} +

+{% endif %} +{% if entry.children.count > 0 %} + +{% 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 %}
  • - + {% if menuitem.icon %} {{ menuitem.icon }} diff --git a/build/docs/.phpdoc/template/css/base.css.twig b/build/docs/.phpdoc/template/css/base.css.twig index 711b29b794..14449f21b9 100644 --- a/build/docs/.phpdoc/template/css/base.css.twig +++ b/build/docs/.phpdoc/template/css/base.css.twig @@ -10,14 +10,35 @@ {% include 'css/variables.css.twig' %} -/* Base Styles --------------------------------------------------- */ -{#@font-face {#} -{# font-family: 'Amazon Ember';#} -{# src: url('/static/AmazonEmber_Rg.ttf') format('truetype');#} -{# font-weight: normal;#} -{# font-style: normal;#} -{#}#} +@font-face { + font-family: 'Glyphicons Halflings'; + src: url(../static/glyphicons-halflings-regular.eot); + src: url(../static/glyphicons-halflings-regular.eot?#iefix) format('embedded-opentype'), + url(../static/glyphicons-halflings-regular.woff2) format('woff2'), + url(../static/glyphicons-halflings-regular.woff) format('woff'), + url(../static/glyphicons-halflings-regular.ttf) format('truetype'), + url(../static/glyphicons-halflings-regular.svg#glyphicons_halflingsregular) format('svg'); +} + +.glyphicon { + position: relative; + top: 1px; + display: inline-block; + font-family: 'Glyphicons Halflings'; + font-style: normal; + font-weight: 400; + line-height: 1; + -webkit-font-smoothing: antialiased; + -moz-osx-font-smoothing: grayscale; +} + +.glyphicon-cog:before { + content:"\e019" +} + +.glyphicon-link:before { + content:"\e144" +} body { background-color: #fff; diff --git a/build/docs/classes/DocsBuilder.php b/build/docs/classes/DocsBuilder.php index aee7ed1ff3..afd84ad9a3 100644 --- a/build/docs/classes/DocsBuilder.php +++ b/build/docs/classes/DocsBuilder.php @@ -709,7 +709,7 @@ private function createHtmlForPaginators(HtmlDocument $html, Api $service) $html->open('dl'); foreach ($paginators as $name => $config) { $html->open('dt', 'phpdocumentor-table-of-contents__entry'); - $attr = ['href' => '#' . strtolower($name)]; + $attr = ['href' => '#' . strtolower($name), 'aria-label' => strtolower($name)]; $html->elem('a', $attr, '' . $name . ''); $html->close(); } @@ -814,10 +814,11 @@ private function createHtmlForOperation(Service $service, $name, Operation $oper 'a', [ 'href' => $service->exceptionLink . '#shape-' - . strtolower($error->getName()) + . strtolower($error->getName()), + 'aria-label' => strtolower($error->getName()) ], '' . $error['name'] . ': ' . '') - ->elem('p', 'phpdocumentor-summary', $desc) + ->elem('dd', 'phpdocumentor-summary', $desc) ->close(); } $html->close(); @@ -832,7 +833,7 @@ private function createHtmlForOperation(Service $service, $name, Operation $oper $exampleId = $this->exampleSlug($name, $exampleNumber); $html->open('h5', ['id' => $exampleId]); $html->elem('span', null, 'Example ' . $exampleNumber . ': ' . $example['title'] ?? ''); - $html->elem('a', ['href' => '#' . $exampleId], $html->glyph('link')); + $html->elem('a', ['href' => '#' . $exampleId, 'aria-label' => 'example link'], $html->glyph('link')); $html->close(); if (isset($example['description'])) { $html->elem('p', 'phpdocumentor-summary', $example['description']); @@ -952,9 +953,9 @@ private function describeParam(AbstractModel $member, $required = false) $html->open('div', 'param-attributes')->open('dl'); if ($required) { - $html->elem('dt', 'required', 'Required: Yes'); + $html->elem('dt', 'required', '
    Required: Yes
    '); } - $html->elem('dt', null, 'Type: ' . "{$typeDesc}"); + $html->elem('dt', null, '
    Type: ' . "{$typeDesc}
    "); $html->close(); $html->close(); @@ -1044,7 +1045,7 @@ private function memberSlug($name) private function memberLink($name) { - return '    ' . $name . ''; + return '' . $name . ''; } private function updateSitemap() diff --git a/build/docs/classes/HtmlDocument.php b/build/docs/classes/HtmlDocument.php index b85cb1e823..433c89d10b 100644 --- a/build/docs/classes/HtmlDocument.php +++ b/build/docs/classes/HtmlDocument.php @@ -33,7 +33,7 @@ public function section($num, $text, $anchorPrefix = null, $class = null, $label { $anchor = $this->slug($anchorPrefix . '-' . $text); $ariaLabel = empty($label) ? null : 'aria-label="Go to ' . $label . '"'; - $link = ' ' . $this->glyph('link') . ''; + $link = ' ' . $this->glyph('link') . ''; $attrs = ['id' => $anchor]; if ($class) { $attrs['class'] = $class; diff --git a/build/docs/static/glyphicons-halflings-regular.eot b/build/docs/static/glyphicons-halflings-regular.eot new file mode 100644 index 0000000000..4a4ca865d6 Binary files /dev/null and b/build/docs/static/glyphicons-halflings-regular.eot differ diff --git a/build/docs/static/glyphicons-halflings-regular.svg b/build/docs/static/glyphicons-halflings-regular.svg new file mode 100644 index 0000000000..25691af8f1 --- /dev/null +++ b/build/docs/static/glyphicons-halflings-regular.svg @@ -0,0 +1,229 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/build/docs/static/glyphicons-halflings-regular.ttf b/build/docs/static/glyphicons-halflings-regular.ttf new file mode 100644 index 0000000000..67fa00bf83 Binary files /dev/null and b/build/docs/static/glyphicons-halflings-regular.ttf differ diff --git a/build/docs/static/glyphicons-halflings-regular.woff b/build/docs/static/glyphicons-halflings-regular.woff new file mode 100644 index 0000000000..8c54182aa5 Binary files /dev/null and b/build/docs/static/glyphicons-halflings-regular.woff differ