Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
19 changes: 19 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# macOS system files
.DS_Store

# MkDocs build artifacts
site/
docs/SUMMARY.md
docs/clients/
**/docs/client/

# Virtual environments
.venv
venv

# Caches
__pycache__/
.ruff_cache/

# Dependency lock file for uv
uv.lock
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,4 +56,4 @@ If you discover a potential security issue in this project we ask that you notif

## Licensing

See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
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.
25 changes: 25 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
DOCS_PORT ?= 8000
PYTHON_VERSION := 3.12

.PHONY: docs docs-serve docs-clean docs-install venv

venv:
uv venv --python $(PYTHON_VERSION)

docs-install: venv
uv pip install -r requirements-docs.in
uv pip install -e clients/*

docs-clean:
rm -rf site docs/clients docs/SUMMARY.md

docs-generate:
uv run python scripts/docs/generate_all_doc_stubs.py
uv run python scripts/docs/generate_nav.py

docs: docs-generate
uv run mkdocs build

docs-serve:
@[ -d site ] || $(MAKE) docs
uv run python -m http.server $(DOCS_PORT) --bind 127.0.0.1 --directory site
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ This is the preferred mechanism to give feedback so that other users can engage

## Security

See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.
See [CONTRIBUTING](https://github.com/awslabs/aws-sdk-python/blob/develop/CONTRIBUTING.md#security-issue-notifications) for more information.

## License

Expand Down
25 changes: 25 additions & 0 deletions clients/aws-sdk-bedrock-runtime/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
DOCS_PORT ?= 8000
CLIENT_DIR := src/aws_sdk_bedrock_runtime
DOCS_OUTPUT_DIR := docs/client
PYTHON_VERSION := 3.12

.PHONY: docs docs-serve docs-clean docs-install venv

venv:
uv venv --python $(PYTHON_VERSION)

docs-install: venv
uv pip install -e . --group docs

docs-clean:
rm -rf site $(DOCS_OUTPUT_DIR)

docs-generate:
uv run --no-sync python scripts/docs/generate_doc_stubs.py -c $(CLIENT_DIR) -o $(DOCS_OUTPUT_DIR)

docs: docs-generate
uv run --no-sync mkdocs build

docs-serve:
@[ -d site ] || $(MAKE) docs
uv run --no-sync python -m http.server $(DOCS_PORT) --bind 127.0.0.1 --directory site
15 changes: 0 additions & 15 deletions clients/aws-sdk-bedrock-runtime/docs/Makefile

This file was deleted.

22 changes: 15 additions & 7 deletions clients/aws-sdk-bedrock-runtime/docs/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,18 @@
## Generating Documentation
## Generating Client Documentation

Sphinx is used for documentation. You can generate HTML locally with the
following:
Material for MkDocs is used for documentation. You can generate the documentation HTML
for this client locally with the following:

```
$ uv pip install --group docs .
$ cd docs
$ make html
```bash
# Install documentation dependencies
make docs-install

# Serve documentation locally
make docs-serve

# OR build static HTML documentation
make docs

# Clean docs artifacts
make docs-clean
```
25 changes: 0 additions & 25 deletions clients/aws-sdk-bedrock-runtime/docs/client/apply_guardrail.rst

This file was deleted.

25 changes: 0 additions & 25 deletions clients/aws-sdk-bedrock-runtime/docs/client/converse.rst

This file was deleted.

25 changes: 0 additions & 25 deletions clients/aws-sdk-bedrock-runtime/docs/client/converse_stream.rst

This file was deleted.

25 changes: 0 additions & 25 deletions clients/aws-sdk-bedrock-runtime/docs/client/count_tokens.rst

This file was deleted.

This file was deleted.

11 changes: 0 additions & 11 deletions clients/aws-sdk-bedrock-runtime/docs/client/index.rst

This file was deleted.

25 changes: 0 additions & 25 deletions clients/aws-sdk-bedrock-runtime/docs/client/invoke_model.rst

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

Loading
Loading