Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
<!-- --8<-- [start:docs] -->
Comment thread
arandito marked this conversation as resolved.
Outdated
# Contributing Guidelines

Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional
Expand Down Expand Up @@ -53,7 +54,7 @@ opensource-codeofconduct@amazon.com with any additional questions or comments.
## Security issue notifications
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.


<!-- --8<-- [end:docs] -->
## Licensing

See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
## AWS SDK for Python
<!-- --8<-- [start:docs] -->
[![Apache 2 licensed][apache-badge]][apache-url]

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

<!-- --8<-- [end:docs] -->
## Security

See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
Expand Down
4 changes: 4 additions & 0 deletions docs/contributing/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
--8<-- "CONTRIBUTING.md:docs"
## Licensing

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.
3 changes: 3 additions & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# AWS SDK for Python

--8<-- "README.md:docs"
3 changes: 3 additions & 0 deletions docs/stylesheets/extra.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
.md-grid {
Comment thread
arandito marked this conversation as resolved.
Outdated
max-width: 70rem;
}
82 changes: 82 additions & 0 deletions mkdocs.yml
Comment thread
arandito marked this conversation as resolved.
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
site_name: AWS SDK for Python
site_description: Documentation for AWS SDK for Python Clients

copyright: Copyright &copy; 2025, Amazon Web Services, Inc
Comment thread
arandito marked this conversation as resolved.
Outdated
repo_name: awslabs/aws-sdk-python
repo_url: https://github.com/awslabs/aws-sdk-python

theme:
name: material
Comment thread
arandito marked this conversation as resolved.
palette:
- scheme: default
Comment thread
arandito marked this conversation as resolved.
Outdated
primary: white
accent: light blue
toggle:
icon: material/brightness-7
name: Switch to dark mode
- scheme: slate
primary: black
accent: light blue
toggle:
icon: material/brightness-4
name: Switch to light mode
features:
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
- search.suggest
- search.highlight
- content.code.copy

plugins:
- search
- gen-files:
scripts:
- scripts/generate_doc_stubs.py
- scripts/generate_nav.py
- mkdocstrings:
handlers:
python:
options:
show_source: false
show_signature: true
show_signature_annotations: true
show_root_heading: true
show_root_full_path: false
show_object_full_path: false
show_symbol_type_heading: true
show_symbol_type_toc: true
show_category_heading: true
group_by_category: true
separate_signature: true
signature_crossrefs: true
filters:
- "!^_"
- "!^deserialize"
- "!^serialize"

markdown_extensions:
- pymdownx.highlight
- pymdownx.inlinehilite
- pymdownx.snippets:
base_path: ['.']
Comment thread
arandito marked this conversation as resolved.
Outdated
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- admonition
- def_list
- toc:
permalink: true
toc_depth: 3

extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/awslabs/aws-sdk-python

extra_css:
- stylesheets/extra.css

validation:
nav:
omitted_files: ignore
20 changes: 20 additions & 0 deletions pyproject.toml
Comment thread
arandito marked this conversation as resolved.
Outdated
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
[project]
name = "aws-sdk-python"
version = "0.1.0"
description = "Add your description here"
readme = "README.md"
requires-python = ">=3.12"
dependencies = [
"mkdocs-awesome-pages-plugin>=2.10.1",
]
Comment thread
arandito marked this conversation as resolved.
Outdated

[dependency-groups]
dev = [
"mkdocs-awesome-pages-plugin>=2.10.1",
]
docs = [
"mkdocs==1.6.1",
"mkdocstrings[python]==0.30.1",
"mkdocs-material==9.7.0",
"mkdocs-gen-files>=0.5.0",
]
Loading