Skip to content

Commit 1d90330

Browse files
aranditoarandito
committed
Implement initial top-level doc gen
1 parent 2a4d0ac commit 1d90330

File tree

9 files changed

+847
-6
lines changed

9 files changed

+847
-6
lines changed

‎CONTRIBUTING.md‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
<!-- --8<-- [start:docs] -->
12
# Contributing Guidelines
23

34
Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional
@@ -51,9 +52,4 @@ opensource-codeofconduct@amazon.com with any additional questions or comments.
5152

5253

5354
## Security issue notifications
54-
If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.
55-
56-
57-
## Licensing
58-
59-
See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
55+
If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a

‎README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
## AWS SDK for Python
2+
<!-- --8<-- [start:docs] -->
23
[![Apache 2 licensed][apache-badge]][apache-url]
34

45
[apache-badge]: https://img.shields.io/badge/license-APACHE2-blue.svg
@@ -29,6 +30,7 @@ features we are actively working on.
2930
You can provide feedback or report a bug by submitting an [issue](https://github.com/awslabs/aws-sdk-python/issues/new/choose).
3031
This is the preferred mechanism to give feedback so that other users can engage in the conversation, +1 issues, etc.
3132

33+
<!-- --8<-- [end:docs] -->
3234
## Security
3335

3436
See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.

‎docs/contributing/index.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
--8<-- "CONTRIBUTING.md:docs"
2+
## Licensing
3+
4+
See the [LICENSE](https://github.com/awslabs/aws-sdk-python/blob/develop/LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.

‎docs/index.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# AWS SDK for Python
2+
3+
--8<-- "README.md:docs"

‎docs/stylesheets/extra.css‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
.md-grid {
2+
max-width: 70rem;
3+
}

‎mkdocs.yml‎

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
site_name: AWS SDK for Python
2+
site_description: Documentation for AWS SDK for Python Clients
3+
4+
copyright: Copyright &copy; 2025, Amazon Web Services, Inc
5+
repo_name: awslabs/aws-sdk-python
6+
repo_url: https://github.com/awslabs/aws-sdk-python
7+
8+
theme:
9+
name: material
10+
palette:
11+
- scheme: default
12+
primary: white
13+
accent: light blue
14+
toggle:
15+
icon: material/brightness-7
16+
name: Switch to dark mode
17+
- scheme: slate
18+
primary: black
19+
accent: light blue
20+
toggle:
21+
icon: material/brightness-4
22+
name: Switch to light mode
23+
features:
24+
- navigation.tabs
25+
- navigation.tabs.sticky
26+
- navigation.top
27+
- search.suggest
28+
- search.highlight
29+
- content.code.copy
30+
31+
plugins:
32+
- search
33+
- gen-files:
34+
scripts:
35+
- scripts/generate_doc_stubs.py
36+
- scripts/generate_nav.py
37+
- mkdocstrings:
38+
handlers:
39+
python:
40+
options:
41+
show_source: false
42+
show_signature: true
43+
show_signature_annotations: true
44+
show_root_heading: true
45+
show_root_full_path: false
46+
show_object_full_path: false
47+
show_symbol_type_heading: true
48+
show_symbol_type_toc: true
49+
show_category_heading: true
50+
group_by_category: true
51+
separate_signature: true
52+
signature_crossrefs: true
53+
filters:
54+
- "!^_"
55+
- "!^deserialize"
56+
- "!^serialize"
57+
58+
markdown_extensions:
59+
- pymdownx.highlight
60+
- pymdownx.inlinehilite
61+
- pymdownx.snippets:
62+
base_path: ['.']
63+
- pymdownx.superfences
64+
- pymdownx.tabbed:
65+
alternate_style: true
66+
- admonition
67+
- def_list
68+
- toc:
69+
permalink: true
70+
toc_depth: 3
71+
72+
extra:
73+
social:
74+
- icon: fontawesome/brands/github
75+
link: https://github.com/awslabs/aws-sdk-python
76+
77+
extra_css:
78+
- stylesheets/extra.css
79+
80+
validation:
81+
nav:
82+
omitted_files: ignore

‎pyproject.toml‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
[project]
2+
name = "aws-sdk-python"
3+
version = "0.1.0"
4+
description = "Add your description here"
5+
readme = "README.md"
6+
requires-python = ">=3.12"
7+
dependencies = [
8+
"mkdocs-awesome-pages-plugin>=2.10.1",
9+
]
10+
11+
[dependency-groups]
12+
dev = [
13+
"mkdocs-awesome-pages-plugin>=2.10.1",
14+
]
15+
docs = [
16+
"mkdocs==1.6.1",
17+
"mkdocstrings[python]==0.30.1",
18+
"mkdocs-material==9.7.0",
19+
"mkdocs-gen-files>=0.5.0",
20+
]

0 commit comments

Comments
 (0)