| FazBrowse GitHub Viewer | Trending | | Home |
| Tools: [Download Repo ZIP] [Original HTTPS Page] |
1 parent cc11619 commit 276bcf7
11 files changed
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -30,6 +30,8 @@ jobs: | |||
| 30 | 30 | - pyproject.toml | |
| 31 | 31 | - mkdocs.yml | |
| 32 | 32 | - mkdocs.insiders.yml | |
| 33 | + - ./github/workflows/build-docs.yml | ||
| 34 | + - ./github/workflows/deploy-docs.yml | ||
| 33 | 35 | ||
| 34 | 36 | build-docs: | |
| 35 | 37 | needs: | |
@@ -69,12 +71,10 @@ jobs: | |||
| 69 | 71 | with: | |
| 70 | 72 | key: mkdocs-cards-${{ github.ref }} | |
| 71 | 73 | path: .cache | |
| 74 | + - name: Verify README | ||
| 75 | + run: python ./scripts/docs.py verify-readme | ||
| 72 | 76 | - name: Build Docs | |
| 73 | - if: github.event_name == 'pull_request' && github.secret_source != 'Actions' | ||
| 74 | - run: python -m poetry run mkdocs build | ||
| 75 | - - name: Build Docs with Insiders | ||
| 76 | - if: github.event_name != 'pull_request' || github.secret_source == 'Actions' | ||
| 77 | - run: python -m poetry run mkdocs build --config-file mkdocs.insiders.yml | ||
| 77 | + run: python ./scripts/docs.py build | ||
| 78 | 78 | - uses: actions/upload-artifact@v3 | |
| 79 | 79 | with: | |
| 80 | 80 | name: docs-site | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -38,6 +38,14 @@ The key features are: | |||
| 38 | 38 | * **Extensible**: You have all the power of SQLAlchemy and Pydantic underneath. | |
| 39 | 39 | * **Short**: Minimize code duplication. A single type annotation does a lot of work. No need to duplicate models in SQLAlchemy and Pydantic. | |
| 40 | 40 | ||
| 41 | + ## Sponsors | ||
| 42 | + | ||
| 43 | + <!-- sponsors --> | ||
| 44 | + | ||
| 45 | + <a href="https://www.govcert.lu" target="_blank" title="This project is being supported by GOVCERT.LU"><img src="https://sqlmodel.tiangolo.com/img/sponsors/govcert.png"></a> | ||
| 46 | + | ||
| 47 | + <!-- /sponsors --> | ||
| 48 | + | ||
| 41 | 49 | ## SQL Databases in FastAPI | |
| 42 | 50 | ||
| 43 | 51 | <a href="https://fastapi.tiangolo.com" target="_blank"><img src="https://fastapi.tiangolo.com/img/logo-margin/logo-teal.png" style="width: 20%;"></a> | |
@@ -68,7 +76,7 @@ Successfully installed sqlmodel | |||
| 68 | 76 | ||
| 69 | 77 | ## Example | |
| 70 | 78 | ||
| 71 | - For an introduction to databases, SQL, and everything else, see the <a href="https://sqlmodel.tiangolo.com" target="_blank">SQLModel documentation</a>. | ||
| 79 | + For an introduction to databases, SQL, and everything else, see the <a href="https://sqlmodel.tiangolo.com/databases/" target="_blank">SQLModel documentation</a>. | ||
| 72 | 80 | ||
| 73 | 81 | Here's a quick example. ✨ | |
| 74 | 82 | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -0,0 +1,6 @@ | |||
| 1 | + gold: [] | ||
| 2 | + silver: | ||
| 3 | + - url: https://www.govcert.lu | ||
| 4 | + title: This project is being supported by GOVCERT.LU | ||
| 5 | + img: https://sqlmodel.tiangolo.com/img/sponsors/govcert.png | ||
| 6 | + bronze: [] | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1,3 +1,7 @@ | |||
| 1 | + <style> | ||
| 2 | + .md-content .md-typeset h1 { display: none; } | ||
| 3 | + </style> | ||
| 4 | + | ||
| 1 | 5 | <p align="center"> | |
| 2 | 6 | <a href="https://sqlmodel.tiangolo.com"><img src="https://sqlmodel.tiangolo.com/img/logo-margin/logo-margin-vector.svg" alt="SQLModel"></a> | |
| 3 | 7 | </p> | |
@@ -38,6 +42,21 @@ The key features are: | |||
| 38 | 42 | * **Extensible**: You have all the power of SQLAlchemy and Pydantic underneath. | |
| 39 | 43 | * **Short**: Minimize code duplication. A single type annotation does a lot of work. No need to duplicate models in SQLAlchemy and Pydantic. | |
| 40 | 44 | ||
| 45 | + ## Sponsors | ||
| 46 | + | ||
| 47 | + <!-- sponsors --> | ||
| 48 | + | ||
| 49 | + {% if sponsors %} | ||
| 50 | + {% for sponsor in sponsors.gold -%} | ||
| 51 | + <a href="{{ sponsor.url }}" target="_blank" title="{{ sponsor.title }}"><img src="{{ sponsor.img }}" style="border-radius:15px"></a> | ||
| 52 | + {% endfor -%} | ||
| 53 | + {%- for sponsor in sponsors.silver -%} | ||
| 54 | + <a href="{{ sponsor.url }}" target="_blank" title="{{ sponsor.title }}"><img src="{{ sponsor.img }}" style="border-radius:15px"></a> | ||
| 55 | + {% endfor %} | ||
| 56 | + {% endif %} | ||
| 57 | + | ||
| 58 | + <!-- /sponsors --> | ||
| 59 | + | ||
| 41 | 60 | ## SQL Databases in FastAPI | |
| 42 | 61 | ||
| 43 | 62 | <a href="https://fastapi.tiangolo.com" target="_blank"><img src="https://fastapi.tiangolo.com/img/logo-margin/logo-teal.png" style="width: 20%;"></a> | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1,4 +1,3 @@ | |||
| 1 | - INHERIT: mkdocs.yml | ||
| 2 | 1 | plugins: | |
| 3 | - - search | ||
| 4 | - - social | ||
| 2 | + social: | ||
| 3 | + typeset: | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -0,0 +1,6 @@ | |||
| 1 | + # Define this here and not in the main mkdocs.yml file because that one could be auto | ||
| 2 | + # updated and written, and the script would remove the env var | ||
| 3 | + INHERIT: !ENV [INSIDERS_FILE, './mkdocs.no-insiders.yml'] | ||
| 4 | + markdown_extensions: | ||
| 5 | + pymdownx.highlight: | ||
| 6 | + linenums: !ENV [LINENUMS, false] | ||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -1,3 +1,4 @@ | |||
| 1 | + INHERIT: ./mkdocs.maybe-insiders.yml | ||
| 1 | 2 | site_name: SQLModel | |
| 2 | 3 | site_description: SQLModel, SQL databases in Python, designed for simplicity, compatibility, and robustness. | |
| 3 | 4 | site_url: https://sqlmodel.tiangolo.com/ | |
@@ -36,6 +37,11 @@ theme: | |||
| 36 | 37 | repo_name: tiangolo/sqlmodel | |
| 37 | 38 | repo_url: https://github.com/tiangolo/sqlmodel | |
| 38 | 39 | edit_uri: '' | |
| 40 | + plugins: | ||
| 41 | + search: null | ||
| 42 | + markdownextradata: | ||
| 43 | + data: ./data | ||
| 44 | + | ||
| 39 | 45 | nav: | |
| 40 | 46 | - SQLModel: index.md | |
| 41 | 47 | - features.md | |
@@ -98,30 +104,28 @@ nav: | |||
| 98 | 104 | - release-notes.md | |
| 99 | 105 | ||
| 100 | 106 | markdown_extensions: | |
| 101 | - - markdown.extensions.attr_list | ||
| 102 | - - markdown.extensions.tables | ||
| 103 | - - markdown.extensions.md_in_html | ||
| 104 | - - toc: | ||
| 107 | + markdown.extensions.attr_list: | ||
| 108 | + markdown.extensions.tables: | ||
| 109 | + markdown.extensions.md_in_html: | ||
| 110 | + toc: | ||
| 105 | 111 | permalink: true | |
| 106 | - - pymdownx.superfences: | ||
| 112 | + pymdownx.superfences: | ||
| 107 | 113 | custom_fences: | |
| 108 | 114 | - name: mermaid | |
| 109 | 115 | class: mermaid | |
| 110 | 116 | format: !!python/name:pymdownx.superfences.fence_code_format '' | |
| 111 | - - pymdownx.betterem | ||
| 112 | - - pymdownx.highlight: | ||
| 113 | - linenums: !ENV [LINENUMS, false] | ||
| 114 | - - pymdownx.blocks.details | ||
| 115 | - - pymdownx.blocks.admonition: | ||
| 117 | + pymdownx.betterem: | ||
| 118 | + pymdownx.blocks.details: | ||
| 119 | + pymdownx.blocks.admonition: | ||
| 116 | 120 | types: | |
| 117 | 121 | - note | |
| 118 | 122 | - info | |
| 119 | 123 | - tip | |
| 120 | 124 | - warning | |
| 121 | 125 | - danger | |
| 122 | - - pymdownx.blocks.tab: | ||
| 126 | + pymdownx.blocks.tab: | ||
| 123 | 127 | alternate_style: True | |
| 124 | - - mdx_include | ||
| 128 | + mdx_include: | ||
| 125 | 129 | ||
| 126 | 130 | extra: | |
| 127 | 131 | analytics: | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -50,6 +50,8 @@ fastapi = "^0.103.2" | |||
| 50 | 50 | ruff = "^0.1.2" | |
| 51 | 51 | # For FastAPI tests | |
| 52 | 52 | httpx = "0.24.1" | |
| 53 | + typer-cli = "^0.0.13" | ||
| 54 | + mkdocs-markdownextradata-plugin = ">=0.1.7,<0.3.0" | ||
| 53 | 55 | ||
| 54 | 56 | [build-system] | |
| 55 | 57 | requires = ["poetry-core"] | |
| Back | FazBrowse Home | New Git URL |
0 commit comments