-
Notifications
You must be signed in to change notification settings - Fork 28
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix broken docs code and links (#549)
* Fix docs for console basics * Fix broken links in docs * Commit cookiecutter generated files
- Loading branch information
1 parent
cc5e29d
commit d0bef46
Showing
62 changed files
with
1,188 additions
and
77 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
7 changes: 5 additions & 2 deletions
7
docs/docs_src/getting_started/fastapi/my_fastagency_app/.devcontainer/docker-compose.yml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,18 +1,21 @@ | ||
| version: '3' | ||
|
|
||
| services: | ||
| # nosemgrep: yaml.docker-compose.security.writable-filesystem-service.writable-filesystem-service | ||
| python-3.12-my_fastagency_app: | ||
| image: mcr.microsoft.com/devcontainers/python:3.12 | ||
| container_name: my_fastagency_app-${USER}-python-3.12 | ||
| volumes: | ||
| - ../:/workspaces/my_fastagency_app:cached | ||
| command: sleep infinity | ||
|
|
||
| env_file: | ||
| - ./devcontainer.env | ||
| security_opt: | ||
| - no-new-privileges:true | ||
| networks: | ||
| - my_fastagency_app-network | ||
|
|
||
| networks: | ||
| my_fastagency_app-network: | ||
| name: my_fastagency_app-${USER}-network |
17 changes: 17 additions & 0 deletions
17
docs/docs_src/getting_started/fastapi/my_fastagency_app/.github/dependabot.yml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| # To get started with Dependabot version updates, you'll need to specify which | ||
| # package ecosystems to update and where the package manifests are located. | ||
| # Please see the documentation for all configuration options: | ||
| # https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates | ||
|
|
||
| version: 2 | ||
| updates: | ||
| # GitHub Actions | ||
| - package-ecosystem: "github-actions" | ||
| directory: "/" | ||
| schedule: | ||
| interval: "weekly" | ||
| # Python | ||
| - package-ecosystem: "pip" # See documentation for possible values | ||
| directory: "/" # Location of package manifests | ||
| schedule: | ||
| interval: "weekly" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -47,4 +47,3 @@ jobs: | |
| run: pytest | ||
| env: | ||
| CONTEXT: ${{ runner.os }}-py${{ matrix.python-version }} | ||
|
|
||
18 changes: 18 additions & 0 deletions
18
docs/docs_src/getting_started/fastapi/my_fastagency_app/.gitignore
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| __pycache__ | ||
| dist | ||
| .idea | ||
| venv* | ||
| .venv* | ||
| .env | ||
| .env* | ||
| *.lock | ||
| .vscode | ||
| .pypirc | ||
| .pytest_cache | ||
| .ruff_cache | ||
| .mypy_cache | ||
| .coverage* | ||
| .cache | ||
| htmlcov | ||
| token | ||
| .DS_Store |
38 changes: 38 additions & 0 deletions
38
docs/docs_src/getting_started/fastapi/my_fastagency_app/.pre-commit-config.yaml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| # See https://pre-commit.com for more information | ||
| # See https://pre-commit.com/hooks.html for more hooks | ||
| repos: | ||
| - repo: https://github.com/pre-commit/pre-commit-hooks | ||
| rev: v5.0.0 | ||
| hooks: | ||
| - id: trailing-whitespace | ||
| - id: end-of-file-fixer | ||
| - id: check-yaml | ||
| - id: check-added-large-files | ||
|
|
||
| - repo: local | ||
| hooks: | ||
| - id: lint | ||
| name: Linter | ||
| entry: "scripts/lint-pre-commit.sh" | ||
| language: python | ||
| # language_version: python3.12 | ||
| types: [python] | ||
| require_serial: true | ||
| verbose: true | ||
|
|
||
| - repo: local | ||
| hooks: | ||
| - id: static-analysis | ||
| name: Static analysis | ||
| entry: "scripts/static-pre-commit.sh" | ||
| language: python | ||
| # language_version: python3.12 | ||
| types: [python] | ||
| require_serial: true | ||
| verbose: true | ||
|
|
||
| - repo: https://github.com/Yelp/detect-secrets | ||
| rev: v1.5.0 | ||
| hooks: | ||
| - id: detect-secrets | ||
| args: ["--baseline", ".secrets.baseline"] |
127 changes: 127 additions & 0 deletions
127
docs/docs_src/getting_started/fastapi/my_fastagency_app/.secrets.baseline
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,127 @@ | ||
| { | ||
| "version": "1.5.0", | ||
| "plugins_used": [ | ||
| { | ||
| "name": "ArtifactoryDetector" | ||
| }, | ||
| { | ||
| "name": "AWSKeyDetector" | ||
| }, | ||
| { | ||
| "name": "AzureStorageKeyDetector" | ||
| }, | ||
| { | ||
| "name": "Base64HighEntropyString", | ||
| "limit": 4.5 | ||
| }, | ||
| { | ||
| "name": "BasicAuthDetector" | ||
| }, | ||
| { | ||
| "name": "CloudantDetector" | ||
| }, | ||
| { | ||
| "name": "DiscordBotTokenDetector" | ||
| }, | ||
| { | ||
| "name": "GitHubTokenDetector" | ||
| }, | ||
| { | ||
| "name": "GitLabTokenDetector" | ||
| }, | ||
| { | ||
| "name": "HexHighEntropyString", | ||
| "limit": 3.0 | ||
| }, | ||
| { | ||
| "name": "IbmCloudIamDetector" | ||
| }, | ||
| { | ||
| "name": "IbmCosHmacDetector" | ||
| }, | ||
| { | ||
| "name": "IPPublicDetector" | ||
| }, | ||
| { | ||
| "name": "JwtTokenDetector" | ||
| }, | ||
| { | ||
| "name": "KeywordDetector", | ||
| "keyword_exclude": "" | ||
| }, | ||
| { | ||
| "name": "MailchimpDetector" | ||
| }, | ||
| { | ||
| "name": "NpmDetector" | ||
| }, | ||
| { | ||
| "name": "OpenAIDetector" | ||
| }, | ||
| { | ||
| "name": "PrivateKeyDetector" | ||
| }, | ||
| { | ||
| "name": "PypiTokenDetector" | ||
| }, | ||
| { | ||
| "name": "SendGridDetector" | ||
| }, | ||
| { | ||
| "name": "SlackDetector" | ||
| }, | ||
| { | ||
| "name": "SoftlayerDetector" | ||
| }, | ||
| { | ||
| "name": "SquareOAuthDetector" | ||
| }, | ||
| { | ||
| "name": "StripeDetector" | ||
| }, | ||
| { | ||
| "name": "TelegramBotTokenDetector" | ||
| }, | ||
| { | ||
| "name": "TwilioKeyDetector" | ||
| } | ||
| ], | ||
| "filters_used": [ | ||
| { | ||
| "path": "detect_secrets.filters.allowlist.is_line_allowlisted" | ||
| }, | ||
| { | ||
| "path": "detect_secrets.filters.common.is_ignored_due_to_verification_policies", | ||
| "min_level": 2 | ||
| }, | ||
| { | ||
| "path": "detect_secrets.filters.heuristic.is_indirect_reference" | ||
| }, | ||
| { | ||
| "path": "detect_secrets.filters.heuristic.is_likely_id_string" | ||
| }, | ||
| { | ||
| "path": "detect_secrets.filters.heuristic.is_lock_file" | ||
| }, | ||
| { | ||
| "path": "detect_secrets.filters.heuristic.is_not_alphanumeric_string" | ||
| }, | ||
| { | ||
| "path": "detect_secrets.filters.heuristic.is_potential_uuid" | ||
| }, | ||
| { | ||
| "path": "detect_secrets.filters.heuristic.is_prefixed_with_dollar_sign" | ||
| }, | ||
| { | ||
| "path": "detect_secrets.filters.heuristic.is_sequential_string" | ||
| }, | ||
| { | ||
| "path": "detect_secrets.filters.heuristic.is_swagger_file" | ||
| }, | ||
| { | ||
| "path": "detect_secrets.filters.heuristic.is_templated_secret" | ||
| } | ||
| ], | ||
| "results": {}, | ||
| "generated_at": "2024-11-07T10:08:12Z" | ||
| } |
Oops, something went wrong.