-
Notifications
You must be signed in to change notification settings - Fork 13
Migrate sphinx documentation system to material for mkdocs #48
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from 8 commits
b06298a
7dc81f7
204d2ed
2523d2d
810f610
ae258a9
9b384de
5974b99
3861d21
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| 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 |
| 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 |
| 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 sync --group docs | ||
|
|
||
| docs-clean: | ||
| rm -rf site $(DOCS_OUTPUT_DIR) | ||
|
|
||
| docs-generate: | ||
| uv run python scripts/docs/generate_doc_stubs.py -c $(CLIENT_DIR) -o $(DOCS_OUTPUT_DIR) | ||
|
|
||
| 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 | ||
This file was deleted.
| 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 | ||
| ``` |
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
This file was deleted.
Uh oh!
There was an error while loading. Please reload this page.