👷 Upgrade build docs configs#1047

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.

Sign up for GitHub

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

Merged
tiangolo merged 19 commits into from
Aug 9, 2024
Merged

👷 Upgrade build docs configs #1047

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
19 commits
Select commit Hold shift + click to select a range
0e63426
👷 Update build docs CI
tiangolo Aug 4, 2024
758eeac
➕ Update dependencies for docs
tiangolo Aug 4, 2024
2a80088
➕ Update dependencies
tiangolo Aug 4, 2024
2cd20d4
🔨 Update docs.py script
tiangolo Aug 4, 2024
5b6d21c
🔧 Update yaml data injection config
tiangolo Aug 4, 2024
8a7b253
🔧 Upgrade MkDocs Material configs with latest plugins and features
tiangolo Aug 5, 2024
660558d
🔨 Add section renamer based on Markdown index.md files
tiangolo Aug 5, 2024
79310ca
🔨 Update docs.py script to use mkdocs subprocess instead of internals
tiangolo Aug 5, 2024
b6512e8
🔥 Remove unused imports
tiangolo Aug 5, 2024
7c5e81a
🎨 [pre-commit.ci] Auto format from pre-commit.com hooks
pre-commit-ci[bot] Aug 5, 2024
dba4d36
🔥 Remove unneeded line
tiangolo Aug 5, 2024
88ffaef
👷 Update and simplify installing requirements from insiders
tiangolo Aug 5, 2024
ec06121
💚 Trigger CI
tiangolo Aug 5, 2024
05fdc60
🔧 Update cache keys to include insiders
tiangolo Aug 5, 2024
adfa1d8
📌 Pin mkdocs-material-insiders for now
tiangolo Aug 5, 2024
db680c4
🔨 Update custom JS scripts to run also on instant loading
tiangolo Aug 6, 2024
5da4c3f
🔥 Remove old comment
tiangolo Aug 6, 2024
18db2ae
Merge branch 'main' into mkdocs-updates
tiangolo Aug 8, 2024
9d5ada4
🔧 Update installation cache key for docs
tiangolo Aug 8, 2024
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
12 changes: 7 additions & 5 deletions .github/workflows/build-docs.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -28,9 +28,12 @@ jobs:
- docs/**
- docs_src/**
- requirements-docs.txt
- requirements-docs-insiders.txt
- pyproject.toml
- mkdocs.yml
- mkdocs.insiders.yml
- mkdocs.maybe-insiders.yml
- mkdocs.no-insiders.yml
- .github/workflows/build-docs.yml
- .github/workflows/deploy-docs.yml

Expand All@@ -53,16 +56,15 @@ jobs:
id: cache
with:
path: ${{ env.pythonLocation }}
key: ${{ runner.os }}-python-docs-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml', 'requirements-docs.txt') }}-v01
key: ${{ runner.os }}-python-docs-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml', 'requirements-docs.txt', 'requirements-docs-insiders.txt', 'requirements-docs-tests.txt') }}-v02
- name: Install docs extras
if: steps.cache.outputs.cache-hit != 'true'
run: pip install -r requirements-docs.txt
- name: Install Material for MkDocs Insiders
if: ( github.event_name != 'pull_request' || github.secret_source == 'Actions' ) && steps.cache.outputs.cache-hit != 'true'
run: |
pip install git+https://${{ secrets.SQLMODEL_MKDOCS_MATERIAL_INSIDERS }}@github.com/squidfunk/mkdocs-material-insiders.git
pip install git+https://${{ secrets.SQLMODEL_MKDOCS_MATERIAL_INSIDERS }}@github.com/pawamoy-insiders/griffe-typing-deprecated.git
pip install git+https://${{ secrets.SQLMODEL_MKDOCS_MATERIAL_INSIDERS }}@github.com/pawamoy-insiders/mkdocstrings-python.git
run: pip install -r requirements-docs-insiders.txt
env:
TOKEN: ${{ secrets.SQLMODEL_MKDOCS_MATERIAL_INSIDERS }}
- uses: actions/cache@v4
with:
key: mkdocs-cards-${{ github.ref }}
Expand Down
4 changes: 3 additions & 1 deletion docs/js/custom.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -110,4 +110,6 @@ async function main() {
setupTermynal()
}

main()
document$.subscribe(() => {
main()
})
2 changes: 2 additions & 0 deletions docs/tutorial/index.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
# Intro, Installation, and First Steps

Before we start playing with **SQLModel**, let's prepare everything else we need. A bit of type annotations, setting up the environment to install everything, and installing DB Browser for SQLite. 🤓

## Type hints

If you need a refresher about how to use Python type hints (type annotations), check <a href="https://fastapi.tiangolo.com/python-types/" class="external-link" target="_blank">FastAPI's Python types intro</a>.
Expand Down
6 changes: 5 additions & 1 deletion mkdocs.insiders.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
plugins:
social:
typeset:
markdown_extensions:
material.extensions.preview:
targets:
include:
- ./*
89 changes: 71 additions & 18 deletions mkdocs.yml
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -25,28 +25,43 @@ theme:
icon: material/lightbulb-outline
name: Switch to system preference
features:
- search.suggest
- search.highlight
- content.code.annotate
- content.code.copy
# - content.code.select
- content.footnote.tooltips
- content.tabs.link
- navigation.indexes
- content.tooltips
- navigation.footer
- navigation.indexes
- navigation.instant
- navigation.instant.prefetch
- navigation.instant.preview
- navigation.instant.progress
- navigation.path
- content.code.annotate
- content.code.copy
- content.code.select
# - navigation.tabs
# - navigation.tabs.sticky
- navigation.top
- navigation.tracking
- search.highlight
- search.share
- search.suggest
- toc.follow

icon:
repo: fontawesome/brands/github-alt
logo: img/icon-white.svg
favicon: img/favicon.png
language: en
repo_name: tiangolo/sqlmodel
repo_url: https://github.com/tiangolo/sqlmodel
edit_uri: ''
plugins:
search: null
markdownextradata:
data: ./data
# Material for MkDocs
search:
social:
# Other plugins
macros:
include_yaml:
- sponsors: data/sponsors.yml

nav:
- SQLModel: index.md
Expand DownExpand Up@@ -113,33 +128,68 @@ nav:
- release-notes.md

markdown_extensions:
markdown.extensions.attr_list:
markdown.extensions.tables:
markdown.extensions.md_in_html:
# Python Markdown
abbr:
attr_list:
footnotes:
md_in_html:
tables:
toc:
permalink: true

# Python Markdown Extensions
pymdownx.betterem:
smart_enable: all
pymdownx.caret:
pymdownx.highlight:
line_spans: __span
pymdownx.inlinehilite:
pymdownx.keys:
pymdownx.mark:
pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format ''
pymdownx.betterem:
pymdownx.blocks.details:
format: !!python/name:pymdownx.superfences.fence_code_format
pymdownx.tilde:

# pymdownx blocks
pymdownx.blocks.admonition:
types:
- note
- info
- attention
- caution
- danger
- error
- tip
- hint
- warning
- danger
# Custom types
- info
pymdownx.blocks.details:
pymdownx.blocks.tab:
alternate_style: True

# Other extensions
mdx_include:

extra:
analytics:
provider: google
property: G-J8HVTT936W
feedback:
title: Was this page helpful?
ratings:
- icon: material/emoticon-happy-outline
name: This page was helpful
data: 1
note: >-
Thanks for your feedback!
- icon: material/emoticon-sad-outline
name: This page could be improved
data: 0
note: >-
Thanks for your feedback!
social:
- icon: fontawesome/brands/github-alt
link: https://github.com/tiangolo/sqlmodel
Expand All@@ -161,3 +211,6 @@ extra_css:
extra_javascript:
- js/termynal.js
- js/custom.js

hooks:
- scripts/mkdocs_hooks.py
3 changes: 3 additions & 0 deletions requirements-docs-insiders.txt
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
git+https://${TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git@9.5.30-insiders-4.53.11
git+https://${TOKEN}@github.com/pawamoy-insiders/griffe-typing-deprecated.git
git+https://${TOKEN}@github.com/pawamoy-insiders/mkdocstrings-python.git
10 changes: 5 additions & 5 deletions requirements-docs.txt
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
-e .
-r requirements-docs-tests.txt
mkdocs-material==9.4.7
mkdocs-material==9.5.18
mdx-include >=1.4.1,<2.0.0
mkdocs-markdownextradata-plugin >=0.1.7,<0.3.0
mkdocs-redirects>=1.2.1,<1.3.0
pyyaml >=5.3.1,<7.0.0
# For Material for MkDocs, Chinese search
jieba==0.42.1
# jieba==0.42.1
# For image processing by Material for MkDocs
pillow==10.1.0
pillow==10.3.0
# For image processing by Material for MkDocs
cairosvg==2.7.1
mkdocstrings[python]==0.25.1
# mkdocstrings[python]==0.25.1
# Enable griffe-typingdoc once dropping Python 3.7 and upgrading typing-extensions
# griffe-typingdoc==0.2.5
# For griffe, it formats with black
typer == 0.12.3
mkdocs-macros-plugin==1.0.5
17 changes: 12 additions & 5 deletions scripts/docs.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,9 +7,6 @@
from importlib import metadata
from pathlib import Path

import mkdocs.commands.build
import mkdocs.commands.serve
import mkdocs.config
import mkdocs.utils
import typer
from jinja2 import Template
Expand DownExpand Up@@ -68,6 +65,13 @@ def generate_readme_content() -> str:
pre_content = content[frontmatter_end:pre_end]
post_content = content[post_start:]
new_content = pre_content + message + post_content
# Remove content between <!-- only-mkdocs --> and <!-- /only-mkdocs -->
new_content = re.sub(
r"<!-- only-mkdocs -->.*?<!-- /only-mkdocs -->",
"",
new_content,
flags=re.DOTALL,
)
return new_content


Expand DownExpand Up@@ -111,8 +115,11 @@ def live() -> None:
en.
"""
# Enable line numbers during local development to make it easier to highlight
os.environ["LINENUMS"] = "true"
mkdocs.commands.serve.serve(dev_addr="127.0.0.1:8008")
subprocess.run(
["mkdocs", "serve", "--dev-addr", "127.0.0.1:8008", "--dirty"],
env={**os.environ, "LINENUMS": "true"},
check=True,
)


@app.command()
Expand Down
38 changes: 38 additions & 0 deletions scripts/mkdocs_hooks.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
from typing import Any, List, Union

from mkdocs.config.defaults import MkDocsConfig
from mkdocs.structure.files import Files
from mkdocs.structure.nav import Link, Navigation, Section
from mkdocs.structure.pages import Page


def generate_renamed_section_items(
items: List[Union[Page, Section, Link]], *, config: MkDocsConfig
) -> List[Union[Page, Section, Link]]:
new_items: List[Union[Page, Section, Link]] = []
for item in items:
if isinstance(item, Section):
new_title = item.title
new_children = generate_renamed_section_items(item.children, config=config)
first_child = new_children[0]
if isinstance(first_child, Page):
if first_child.file.src_path.endswith("index.md"):
# Read the source so that the title is parsed and available
first_child.read_source(config=config)
new_title = first_child.title or new_title
# Creating a new section makes it render it collapsed by default
# no idea why, so, let's just modify the existing one
# new_section = Section(title=new_title, children=new_children)
item.title = new_title
item.children = new_children
new_items.append(item)
else:
new_items.append(item)
return new_items


def on_nav(
nav: Navigation, *, config: MkDocsConfig, files: Files, **kwargs: Any
) -> Navigation:
new_items = generate_renamed_section_items(nav.items, config=config)
return Navigation(items=new_items, pages=nav.pages)
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
👷 Upgrade build docs configs#1047

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.

 Sign up for GitHub

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

 Merged

tiangolo
merged 19 commits into

from

Aug 9, 2024
 Merged


👷 Upgrade build docs configs
#1047
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


19 commits


Select commit
Hold shift + click to select a range
0e63426

👷 Update build docs CI


tiangolo Aug 4, 2024
758eeac

➕ Update dependencies for docs


tiangolo Aug 4, 2024
2a80088

➕ Update dependencies


tiangolo Aug 4, 2024
2cd20d4

🔨 Update docs.py script


tiangolo Aug 4, 2024
5b6d21c

🔧 Update yaml data injection config


tiangolo Aug 4, 2024
8a7b253

🔧 Upgrade MkDocs Material configs with latest plugins and features


tiangolo Aug 5, 2024
660558d

🔨 Add section renamer based on Markdown index.md files


tiangolo Aug 5, 2024
79310ca

🔨 Update docs.py script to use mkdocs subprocess instead of internals


tiangolo Aug 5, 2024
b6512e8

🔥 Remove unused imports


tiangolo Aug 5, 2024
7c5e81a

🎨 [pre-commit.ci] Auto format from pre-commit.com hooks


pre-commit-ci[bot] Aug 5, 2024
dba4d36

🔥 Remove unneeded line


tiangolo Aug 5, 2024
88ffaef

👷 Update and simplify installing requirements from insiders


tiangolo Aug 5, 2024
ec06121

💚 Trigger CI


tiangolo Aug 5, 2024
05fdc60

🔧 Update cache keys to include insiders


tiangolo Aug 5, 2024
adfa1d8

📌 Pin mkdocs-material-insiders for now


tiangolo Aug 5, 2024
db680c4

🔨 Update custom JS scripts to run also on instant loading


tiangolo Aug 6, 2024
5da4c3f

🔥 Remove old comment


tiangolo Aug 6, 2024
18db2ae

Merge branch 'main' into mkdocs-updates


tiangolo Aug 8, 2024
9d5ada4

🔧 Update installation cache key for docs


tiangolo Aug 8, 2024

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


12 changes: 7 additions & 5 deletions
.github/workflows/build-docs.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,9 +28,12 @@ jobs:
 - docs/**
 - docs_src/**
 - requirements-docs.txt
 - requirements-docs-insiders.txt
 - pyproject.toml
 - mkdocs.yml
 - mkdocs.insiders.yml
 - mkdocs.maybe-insiders.yml
 - mkdocs.no-insiders.yml
 - .github/workflows/build-docs.yml
 - .github/workflows/deploy-docs.yml

Expand All@@ -53,16 +56,15 @@ jobs:
 id: cache
 with:
 path: ${{ env.pythonLocation }}
 key: ${{ runner.os }}-python-docs-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml', 'requirements-docs.txt') }}-v01
 key: ${{ runner.os }}-python-docs-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml', 'requirements-docs.txt', 'requirements-docs-insiders.txt', 'requirements-docs-tests.txt') }}-v02
 - name: Install docs extras
 if: steps.cache.outputs.cache-hit != 'true'
 run: pip install -r requirements-docs.txt
 - name: Install Material for MkDocs Insiders
 if: ( github.event_name != 'pull_request' || github.secret_source == 'Actions' ) && steps.cache.outputs.cache-hit != 'true'
 run: |
 pip install git+https://${{ secrets.SQLMODEL_MKDOCS_MATERIAL_INSIDERS }}@github.com/squidfunk/mkdocs-material-insiders.git
 pip install git+https://${{ secrets.SQLMODEL_MKDOCS_MATERIAL_INSIDERS }}@github.com/pawamoy-insiders/griffe-typing-deprecated.git
 pip install git+https://${{ secrets.SQLMODEL_MKDOCS_MATERIAL_INSIDERS }}@github.com/pawamoy-insiders/mkdocstrings-python.git
 run: pip install -r requirements-docs-insiders.txt
 env:
 TOKEN: ${{ secrets.SQLMODEL_MKDOCS_MATERIAL_INSIDERS }}
 - uses: actions/cache@v4
 with:
 key: mkdocs-cards-${{ github.ref }}
Expand Down

4 changes: 3 additions & 1 deletion
docs/js/custom.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -110,4 +110,6 @@ async function main() {
 setupTermynal()
}

main()
document$.subscribe(() => {
 main()
})

2 changes: 2 additions & 0 deletions
docs/tutorial/index.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
# Intro, Installation, and First Steps

Before we start playing with **SQLModel**, let's prepare everything else we need. A bit of type annotations, setting up the environment to install everything, and installing DB Browser for SQLite. 🤓

## Type hints

If you need a refresher about how to use Python type hints (type annotations), check <a href="https://fastapi.tiangolo.com/python-types/" class="external-link" target="_blank">FastAPI's Python types intro</a>.
Expand Down

6 changes: 5 additions & 1 deletion
mkdocs.insiders.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
plugins:
 social:
 typeset:
markdown_extensions:
 material.extensions.preview:
 targets:
 include:
 - ./*

89 changes: 71 additions & 18 deletions
mkdocs.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,28 +25,43 @@ theme:
 icon: material/lightbulb-outline
 name: Switch to system preference
 features:
 - search.suggest
 - search.highlight
 - content.code.annotate
 - content.code.copy
 # - content.code.select
 - content.footnote.tooltips
 - content.tabs.link
 - navigation.indexes
 - content.tooltips
 - navigation.footer
 - navigation.indexes
 - navigation.instant
 - navigation.instant.prefetch
 - navigation.instant.preview
 - navigation.instant.progress
 - navigation.path
 - content.code.annotate
 - content.code.copy
 - content.code.select
 # - navigation.tabs
 # - navigation.tabs.sticky
 - navigation.top
 - navigation.tracking
 - search.highlight
 - search.share
 - search.suggest
 - toc.follow

 icon:
 repo: fontawesome/brands/github-alt
 logo: img/icon-white.svg
 favicon: img/favicon.png
 language: en
repo_name: tiangolo/sqlmodel
repo_url: https://github.com/tiangolo/sqlmodel
edit_uri: ''
plugins:
 search: null
 markdownextradata:
 data: ./data
 # Material for MkDocs
 search:
 social:
 # Other plugins
 macros:
 include_yaml:
 - sponsors: data/sponsors.yml

nav:
 - SQLModel: index.md
Expand DownExpand Up@@ -113,33 +128,68 @@ nav:
 - release-notes.md

markdown_extensions:
 markdown.extensions.attr_list:
 markdown.extensions.tables:
 markdown.extensions.md_in_html:
 # Python Markdown
 abbr:
 attr_list:
 footnotes:
 md_in_html:
 tables:
 toc:
 permalink: true

 # Python Markdown Extensions
 pymdownx.betterem:
 smart_enable: all
 pymdownx.caret:
 pymdownx.highlight:
 line_spans: __span
 pymdownx.inlinehilite:
 pymdownx.keys:
 pymdownx.mark:
 pymdownx.superfences:
 custom_fences:
 - name: mermaid
 class: mermaid
 format: !!python/name:pymdownx.superfences.fence_code_format ''
 pymdownx.betterem:
 pymdownx.blocks.details:
 format: !!python/name:pymdownx.superfences.fence_code_format
 pymdownx.tilde:

 # pymdownx blocks
 pymdownx.blocks.admonition:
 types:
 - note
 - info
 - attention
 - caution
 - danger
 - error
 - tip
 - hint
 - warning
 - danger
 # Custom types
 - info
 pymdownx.blocks.details:
 pymdownx.blocks.tab:
 alternate_style: True

 # Other extensions
 mdx_include:

extra:
 analytics:
 provider: google
 property: G-J8HVTT936W
 feedback:
 title: Was this page helpful?
 ratings:
 - icon: material/emoticon-happy-outline
 name: This page was helpful
 data: 1
 note: >-
 Thanks for your feedback!
 - icon: material/emoticon-sad-outline
 name: This page could be improved
 data: 0
 note: >-
 Thanks for your feedback!
 social:
 - icon: fontawesome/brands/github-alt
 link: https://github.com/tiangolo/sqlmodel
Expand All@@ -161,3 +211,6 @@ extra_css:
extra_javascript:
 - js/termynal.js
 - js/custom.js

hooks:
 - scripts/mkdocs_hooks.py

3 changes: 3 additions & 0 deletions
requirements-docs-insiders.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
git+https://${TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git@9.5.30-insiders-4.53.11
git+https://${TOKEN}@github.com/pawamoy-insiders/griffe-typing-deprecated.git
git+https://${TOKEN}@github.com/pawamoy-insiders/mkdocstrings-python.git

10 changes: 5 additions & 5 deletions
requirements-docs.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
-e .
-r requirements-docs-tests.txt
mkdocs-material==9.4.7
mkdocs-material==9.5.18
mdx-include >=1.4.1,<2.0.0
mkdocs-markdownextradata-plugin >=0.1.7,<0.3.0
mkdocs-redirects>=1.2.1,<1.3.0
pyyaml >=5.3.1,<7.0.0
# For Material for MkDocs, Chinese search
jieba==0.42.1
# jieba==0.42.1
# For image processing by Material for MkDocs
pillow==10.1.0
pillow==10.3.0
# For image processing by Material for MkDocs
cairosvg==2.7.1
mkdocstrings[python]==0.25.1
# mkdocstrings[python]==0.25.1
# Enable griffe-typingdoc once dropping Python 3.7 and upgrading typing-extensions
# griffe-typingdoc==0.2.5
# For griffe, it formats with black
typer == 0.12.3
mkdocs-macros-plugin==1.0.5

17 changes: 12 additions & 5 deletions
scripts/docs.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,9 +7,6 @@
from importlib import metadata
from pathlib import Path

import mkdocs.commands.build
import mkdocs.commands.serve
import mkdocs.config
import mkdocs.utils
import typer
from jinja2 import Template
Expand DownExpand Up@@ -68,6 +65,13 @@ def generate_readme_content() -> str:
 pre_content = content[frontmatter_end:pre_end]
 post_content = content[post_start:]
 new_content = pre_content + message + post_content
 # Remove content between <!-- only-mkdocs --> and <!-- /only-mkdocs -->
 new_content = re.sub(
 r"<!-- only-mkdocs -->.*?<!-- /only-mkdocs -->",
 "",
 new_content,
 flags=re.DOTALL,
 )
 return new_content


Expand DownExpand Up@@ -111,8 +115,11 @@ def live() -> None:
 en.
 """
 # Enable line numbers during local development to make it easier to highlight
 os.environ["LINENUMS"] = "true"
 mkdocs.commands.serve.serve(dev_addr="127.0.0.1:8008")
 subprocess.run(
 ["mkdocs", "serve", "--dev-addr", "127.0.0.1:8008", "--dirty"],
 env={**os.environ, "LINENUMS": "true"},
 check=True,
 )


@app.command()
Expand Down

38 changes: 38 additions & 0 deletions
scripts/mkdocs_hooks.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
from typing import Any, List, Union

from mkdocs.config.defaults import MkDocsConfig
from mkdocs.structure.files import Files
from mkdocs.structure.nav import Link, Navigation, Section
from mkdocs.structure.pages import Page


def generate_renamed_section_items(
 items: List[Union[Page, Section, Link]], *, config: MkDocsConfig
) -> List[Union[Page, Section, Link]]:
 new_items: List[Union[Page, Section, Link]] = []
 for item in items:
 if isinstance(item, Section):
 new_title = item.title
 new_children = generate_renamed_section_items(item.children, config=config)
 first_child = new_children[0]
 if isinstance(first_child, Page):
 if first_child.file.src_path.endswith("index.md"):
 # Read the source so that the title is parsed and available
 first_child.read_source(config=config)
 new_title = first_child.title or new_title
 # Creating a new section makes it render it collapsed by default
 # no idea why, so, let's just modify the existing one
 # new_section = Section(title=new_title, children=new_children)
 item.title = new_title
 item.children = new_children
 new_items.append(item)
 else:
 new_items.append(item)
 return new_items


def on_nav(
 nav: Navigation, *, config: MkDocsConfig, files: Files, **kwargs: Any
) -> Navigation:
 new_items = generate_renamed_section_items(nav.items, config=config)
 return Navigation(items=new_items, pages=nav.pages)

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
👷 Upgrade build docs configs#1047

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.

 Sign up for GitHub

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

 Merged

tiangolo
merged 19 commits into

from

Aug 9, 2024
 Merged


👷 Upgrade build docs configs
#1047
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


19 commits


Select commit
Hold shift + click to select a range
0e63426

👷 Update build docs CI


tiangolo Aug 4, 2024
758eeac

➕ Update dependencies for docs


tiangolo Aug 4, 2024
2a80088

➕ Update dependencies


tiangolo Aug 4, 2024
2cd20d4

🔨 Update docs.py script


tiangolo Aug 4, 2024
5b6d21c

🔧 Update yaml data injection config


tiangolo Aug 4, 2024
8a7b253

🔧 Upgrade MkDocs Material configs with latest plugins and features


tiangolo Aug 5, 2024
660558d

🔨 Add section renamer based on Markdown index.md files


tiangolo Aug 5, 2024
79310ca

🔨 Update docs.py script to use mkdocs subprocess instead of internals


tiangolo Aug 5, 2024
b6512e8

🔥 Remove unused imports


tiangolo Aug 5, 2024
7c5e81a

🎨 [pre-commit.ci] Auto format from pre-commit.com hooks


pre-commit-ci[bot] Aug 5, 2024
dba4d36

🔥 Remove unneeded line


tiangolo Aug 5, 2024
88ffaef

👷 Update and simplify installing requirements from insiders


tiangolo Aug 5, 2024
ec06121

💚 Trigger CI


tiangolo Aug 5, 2024
05fdc60

🔧 Update cache keys to include insiders


tiangolo Aug 5, 2024
adfa1d8

📌 Pin mkdocs-material-insiders for now


tiangolo Aug 5, 2024
db680c4

🔨 Update custom JS scripts to run also on instant loading


tiangolo Aug 6, 2024
5da4c3f

🔥 Remove old comment


tiangolo Aug 6, 2024
18db2ae

Merge branch 'main' into mkdocs-updates


tiangolo Aug 8, 2024
9d5ada4

🔧 Update installation cache key for docs


tiangolo Aug 8, 2024

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


12 changes: 7 additions & 5 deletions
.github/workflows/build-docs.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,9 +28,12 @@ jobs:
 - docs/**
 - docs_src/**
 - requirements-docs.txt
 - requirements-docs-insiders.txt
 - pyproject.toml
 - mkdocs.yml
 - mkdocs.insiders.yml
 - mkdocs.maybe-insiders.yml
 - mkdocs.no-insiders.yml
 - .github/workflows/build-docs.yml
 - .github/workflows/deploy-docs.yml

Expand All@@ -53,16 +56,15 @@ jobs:
 id: cache
 with:
 path: ${{ env.pythonLocation }}
 key: ${{ runner.os }}-python-docs-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml', 'requirements-docs.txt') }}-v01
 key: ${{ runner.os }}-python-docs-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml', 'requirements-docs.txt', 'requirements-docs-insiders.txt', 'requirements-docs-tests.txt') }}-v02
 - name: Install docs extras
 if: steps.cache.outputs.cache-hit != 'true'
 run: pip install -r requirements-docs.txt
 - name: Install Material for MkDocs Insiders
 if: ( github.event_name != 'pull_request' || github.secret_source == 'Actions' ) && steps.cache.outputs.cache-hit != 'true'
 run: |
 pip install git+https://${{ secrets.SQLMODEL_MKDOCS_MATERIAL_INSIDERS }}@github.com/squidfunk/mkdocs-material-insiders.git
 pip install git+https://${{ secrets.SQLMODEL_MKDOCS_MATERIAL_INSIDERS }}@github.com/pawamoy-insiders/griffe-typing-deprecated.git
 pip install git+https://${{ secrets.SQLMODEL_MKDOCS_MATERIAL_INSIDERS }}@github.com/pawamoy-insiders/mkdocstrings-python.git
 run: pip install -r requirements-docs-insiders.txt
 env:
 TOKEN: ${{ secrets.SQLMODEL_MKDOCS_MATERIAL_INSIDERS }}
 - uses: actions/cache@v4
 with:
 key: mkdocs-cards-${{ github.ref }}
Expand Down

4 changes: 3 additions & 1 deletion
docs/js/custom.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -110,4 +110,6 @@ async function main() {
 setupTermynal()
}

main()
document$.subscribe(() => {
 main()
})

2 changes: 2 additions & 0 deletions
docs/tutorial/index.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
# Intro, Installation, and First Steps

Before we start playing with **SQLModel**, let's prepare everything else we need. A bit of type annotations, setting up the environment to install everything, and installing DB Browser for SQLite. 🤓

## Type hints

If you need a refresher about how to use Python type hints (type annotations), check <a href="https://fastapi.tiangolo.com/python-types/" class="external-link" target="_blank">FastAPI's Python types intro</a>.
Expand Down

6 changes: 5 additions & 1 deletion
mkdocs.insiders.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
plugins:
 social:
 typeset:
markdown_extensions:
 material.extensions.preview:
 targets:
 include:
 - ./*

89 changes: 71 additions & 18 deletions
mkdocs.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,28 +25,43 @@ theme:
 icon: material/lightbulb-outline
 name: Switch to system preference
 features:
 - search.suggest
 - search.highlight
 - content.code.annotate
 - content.code.copy
 # - content.code.select
 - content.footnote.tooltips
 - content.tabs.link
 - navigation.indexes
 - content.tooltips
 - navigation.footer
 - navigation.indexes
 - navigation.instant
 - navigation.instant.prefetch
 - navigation.instant.preview
 - navigation.instant.progress
 - navigation.path
 - content.code.annotate
 - content.code.copy
 - content.code.select
 # - navigation.tabs
 # - navigation.tabs.sticky
 - navigation.top
 - navigation.tracking
 - search.highlight
 - search.share
 - search.suggest
 - toc.follow

 icon:
 repo: fontawesome/brands/github-alt
 logo: img/icon-white.svg
 favicon: img/favicon.png
 language: en
repo_name: tiangolo/sqlmodel
repo_url: https://github.com/tiangolo/sqlmodel
edit_uri: ''
plugins:
 search: null
 markdownextradata:
 data: ./data
 # Material for MkDocs
 search:
 social:
 # Other plugins
 macros:
 include_yaml:
 - sponsors: data/sponsors.yml

nav:
 - SQLModel: index.md
Expand DownExpand Up@@ -113,33 +128,68 @@ nav:
 - release-notes.md

markdown_extensions:
 markdown.extensions.attr_list:
 markdown.extensions.tables:
 markdown.extensions.md_in_html:
 # Python Markdown
 abbr:
 attr_list:
 footnotes:
 md_in_html:
 tables:
 toc:
 permalink: true

 # Python Markdown Extensions
 pymdownx.betterem:
 smart_enable: all
 pymdownx.caret:
 pymdownx.highlight:
 line_spans: __span
 pymdownx.inlinehilite:
 pymdownx.keys:
 pymdownx.mark:
 pymdownx.superfences:
 custom_fences:
 - name: mermaid
 class: mermaid
 format: !!python/name:pymdownx.superfences.fence_code_format ''
 pymdownx.betterem:
 pymdownx.blocks.details:
 format: !!python/name:pymdownx.superfences.fence_code_format
 pymdownx.tilde:

 # pymdownx blocks
 pymdownx.blocks.admonition:
 types:
 - note
 - info
 - attention
 - caution
 - danger
 - error
 - tip
 - hint
 - warning
 - danger
 # Custom types
 - info
 pymdownx.blocks.details:
 pymdownx.blocks.tab:
 alternate_style: True

 # Other extensions
 mdx_include:

extra:
 analytics:
 provider: google
 property: G-J8HVTT936W
 feedback:
 title: Was this page helpful?
 ratings:
 - icon: material/emoticon-happy-outline
 name: This page was helpful
 data: 1
 note: >-
 Thanks for your feedback!
 - icon: material/emoticon-sad-outline
 name: This page could be improved
 data: 0
 note: >-
 Thanks for your feedback!
 social:
 - icon: fontawesome/brands/github-alt
 link: https://github.com/tiangolo/sqlmodel
Expand All@@ -161,3 +211,6 @@ extra_css:
extra_javascript:
 - js/termynal.js
 - js/custom.js

hooks:
 - scripts/mkdocs_hooks.py

3 changes: 3 additions & 0 deletions
requirements-docs-insiders.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
git+https://${TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git@9.5.30-insiders-4.53.11
git+https://${TOKEN}@github.com/pawamoy-insiders/griffe-typing-deprecated.git
git+https://${TOKEN}@github.com/pawamoy-insiders/mkdocstrings-python.git

10 changes: 5 additions & 5 deletions
requirements-docs.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
-e .
-r requirements-docs-tests.txt
mkdocs-material==9.4.7
mkdocs-material==9.5.18
mdx-include >=1.4.1,<2.0.0
mkdocs-markdownextradata-plugin >=0.1.7,<0.3.0
mkdocs-redirects>=1.2.1,<1.3.0
pyyaml >=5.3.1,<7.0.0
# For Material for MkDocs, Chinese search
jieba==0.42.1
# jieba==0.42.1
# For image processing by Material for MkDocs
pillow==10.1.0
pillow==10.3.0
# For image processing by Material for MkDocs
cairosvg==2.7.1
mkdocstrings[python]==0.25.1
# mkdocstrings[python]==0.25.1
# Enable griffe-typingdoc once dropping Python 3.7 and upgrading typing-extensions
# griffe-typingdoc==0.2.5
# For griffe, it formats with black
typer == 0.12.3
mkdocs-macros-plugin==1.0.5

17 changes: 12 additions & 5 deletions
scripts/docs.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,9 +7,6 @@
from importlib import metadata
from pathlib import Path

import mkdocs.commands.build
import mkdocs.commands.serve
import mkdocs.config
import mkdocs.utils
import typer
from jinja2 import Template
Expand DownExpand Up@@ -68,6 +65,13 @@ def generate_readme_content() -> str:
 pre_content = content[frontmatter_end:pre_end]
 post_content = content[post_start:]
 new_content = pre_content + message + post_content
 # Remove content between <!-- only-mkdocs --> and <!-- /only-mkdocs -->
 new_content = re.sub(
 r"<!-- only-mkdocs -->.*?<!-- /only-mkdocs -->",
 "",
 new_content,
 flags=re.DOTALL,
 )
 return new_content


Expand DownExpand Up@@ -111,8 +115,11 @@ def live() -> None:
 en.
 """
 # Enable line numbers during local development to make it easier to highlight
 os.environ["LINENUMS"] = "true"
 mkdocs.commands.serve.serve(dev_addr="127.0.0.1:8008")
 subprocess.run(
 ["mkdocs", "serve", "--dev-addr", "127.0.0.1:8008", "--dirty"],
 env={**os.environ, "LINENUMS": "true"},
 check=True,
 )


@app.command()
Expand Down

38 changes: 38 additions & 0 deletions
scripts/mkdocs_hooks.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
from typing import Any, List, Union

from mkdocs.config.defaults import MkDocsConfig
from mkdocs.structure.files import Files
from mkdocs.structure.nav import Link, Navigation, Section
from mkdocs.structure.pages import Page


def generate_renamed_section_items(
 items: List[Union[Page, Section, Link]], *, config: MkDocsConfig
) -> List[Union[Page, Section, Link]]:
 new_items: List[Union[Page, Section, Link]] = []
 for item in items:
 if isinstance(item, Section):
 new_title = item.title
 new_children = generate_renamed_section_items(item.children, config=config)
 first_child = new_children[0]
 if isinstance(first_child, Page):
 if first_child.file.src_path.endswith("index.md"):
 # Read the source so that the title is parsed and available
 first_child.read_source(config=config)
 new_title = first_child.title or new_title
 # Creating a new section makes it render it collapsed by default
 # no idea why, so, let's just modify the existing one
 # new_section = Section(title=new_title, children=new_children)
 item.title = new_title
 item.children = new_children
 new_items.append(item)
 else:
 new_items.append(item)
 return new_items


def on_nav(
 nav: Navigation, *, config: MkDocsConfig, files: Files, **kwargs: Any
) -> Navigation:
 new_items = generate_renamed_section_items(nav.items, config=config)
 return Navigation(items=new_items, pages=nav.pages)

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
👷 Upgrade build docs configs#1047

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.

 Sign up for GitHub

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

 Merged

tiangolo
merged 19 commits into

from

Aug 9, 2024
 Merged


👷 Upgrade build docs configs
#1047
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


19 commits


Select commit
Hold shift + click to select a range
0e63426

👷 Update build docs CI


tiangolo Aug 4, 2024
758eeac

➕ Update dependencies for docs


tiangolo Aug 4, 2024
2a80088

➕ Update dependencies


tiangolo Aug 4, 2024
2cd20d4

🔨 Update docs.py script


tiangolo Aug 4, 2024
5b6d21c

🔧 Update yaml data injection config


tiangolo Aug 4, 2024
8a7b253

🔧 Upgrade MkDocs Material configs with latest plugins and features


tiangolo Aug 5, 2024
660558d

🔨 Add section renamer based on Markdown index.md files


tiangolo Aug 5, 2024
79310ca

🔨 Update docs.py script to use mkdocs subprocess instead of internals


tiangolo Aug 5, 2024
b6512e8

🔥 Remove unused imports


tiangolo Aug 5, 2024
7c5e81a

🎨 [pre-commit.ci] Auto format from pre-commit.com hooks


pre-commit-ci[bot] Aug 5, 2024
dba4d36

🔥 Remove unneeded line


tiangolo Aug 5, 2024
88ffaef

👷 Update and simplify installing requirements from insiders


tiangolo Aug 5, 2024
ec06121

💚 Trigger CI


tiangolo Aug 5, 2024
05fdc60

🔧 Update cache keys to include insiders


tiangolo Aug 5, 2024
adfa1d8

📌 Pin mkdocs-material-insiders for now


tiangolo Aug 5, 2024
db680c4

🔨 Update custom JS scripts to run also on instant loading


tiangolo Aug 6, 2024
5da4c3f

🔥 Remove old comment


tiangolo Aug 6, 2024
18db2ae

Merge branch 'main' into mkdocs-updates


tiangolo Aug 8, 2024
9d5ada4

🔧 Update installation cache key for docs


tiangolo Aug 8, 2024

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


12 changes: 7 additions & 5 deletions
.github/workflows/build-docs.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,9 +28,12 @@ jobs:
 - docs/**
 - docs_src/**
 - requirements-docs.txt
 - requirements-docs-insiders.txt
 - pyproject.toml
 - mkdocs.yml
 - mkdocs.insiders.yml
 - mkdocs.maybe-insiders.yml
 - mkdocs.no-insiders.yml
 - .github/workflows/build-docs.yml
 - .github/workflows/deploy-docs.yml

Expand All@@ -53,16 +56,15 @@ jobs:
 id: cache
 with:
 path: ${{ env.pythonLocation }}
 key: ${{ runner.os }}-python-docs-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml', 'requirements-docs.txt') }}-v01
 key: ${{ runner.os }}-python-docs-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml', 'requirements-docs.txt', 'requirements-docs-insiders.txt', 'requirements-docs-tests.txt') }}-v02
 - name: Install docs extras
 if: steps.cache.outputs.cache-hit != 'true'
 run: pip install -r requirements-docs.txt
 - name: Install Material for MkDocs Insiders
 if: ( github.event_name != 'pull_request' || github.secret_source == 'Actions' ) && steps.cache.outputs.cache-hit != 'true'
 run: |
 pip install git+https://${{ secrets.SQLMODEL_MKDOCS_MATERIAL_INSIDERS }}@github.com/squidfunk/mkdocs-material-insiders.git
 pip install git+https://${{ secrets.SQLMODEL_MKDOCS_MATERIAL_INSIDERS }}@github.com/pawamoy-insiders/griffe-typing-deprecated.git
 pip install git+https://${{ secrets.SQLMODEL_MKDOCS_MATERIAL_INSIDERS }}@github.com/pawamoy-insiders/mkdocstrings-python.git
 run: pip install -r requirements-docs-insiders.txt
 env:
 TOKEN: ${{ secrets.SQLMODEL_MKDOCS_MATERIAL_INSIDERS }}
 - uses: actions/cache@v4
 with:
 key: mkdocs-cards-${{ github.ref }}
Expand Down

4 changes: 3 additions & 1 deletion
docs/js/custom.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -110,4 +110,6 @@ async function main() {
 setupTermynal()
}

main()
document$.subscribe(() => {
 main()
})

2 changes: 2 additions & 0 deletions
docs/tutorial/index.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
# Intro, Installation, and First Steps

Before we start playing with **SQLModel**, let's prepare everything else we need. A bit of type annotations, setting up the environment to install everything, and installing DB Browser for SQLite. 🤓

## Type hints

If you need a refresher about how to use Python type hints (type annotations), check <a href="https://fastapi.tiangolo.com/python-types/" class="external-link" target="_blank">FastAPI's Python types intro</a>.
Expand Down

6 changes: 5 additions & 1 deletion
mkdocs.insiders.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
plugins:
 social:
 typeset:
markdown_extensions:
 material.extensions.preview:
 targets:
 include:
 - ./*

89 changes: 71 additions & 18 deletions
mkdocs.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,28 +25,43 @@ theme:
 icon: material/lightbulb-outline
 name: Switch to system preference
 features:
 - search.suggest
 - search.highlight
 - content.code.annotate
 - content.code.copy
 # - content.code.select
 - content.footnote.tooltips
 - content.tabs.link
 - navigation.indexes
 - content.tooltips
 - navigation.footer
 - navigation.indexes
 - navigation.instant
 - navigation.instant.prefetch
 - navigation.instant.preview
 - navigation.instant.progress
 - navigation.path
 - content.code.annotate
 - content.code.copy
 - content.code.select
 # - navigation.tabs
 # - navigation.tabs.sticky
 - navigation.top
 - navigation.tracking
 - search.highlight
 - search.share
 - search.suggest
 - toc.follow

 icon:
 repo: fontawesome/brands/github-alt
 logo: img/icon-white.svg
 favicon: img/favicon.png
 language: en
repo_name: tiangolo/sqlmodel
repo_url: https://github.com/tiangolo/sqlmodel
edit_uri: ''
plugins:
 search: null
 markdownextradata:
 data: ./data
 # Material for MkDocs
 search:
 social:
 # Other plugins
 macros:
 include_yaml:
 - sponsors: data/sponsors.yml

nav:
 - SQLModel: index.md
Expand DownExpand Up@@ -113,33 +128,68 @@ nav:
 - release-notes.md

markdown_extensions:
 markdown.extensions.attr_list:
 markdown.extensions.tables:
 markdown.extensions.md_in_html:
 # Python Markdown
 abbr:
 attr_list:
 footnotes:
 md_in_html:
 tables:
 toc:
 permalink: true

 # Python Markdown Extensions
 pymdownx.betterem:
 smart_enable: all
 pymdownx.caret:
 pymdownx.highlight:
 line_spans: __span
 pymdownx.inlinehilite:
 pymdownx.keys:
 pymdownx.mark:
 pymdownx.superfences:
 custom_fences:
 - name: mermaid
 class: mermaid
 format: !!python/name:pymdownx.superfences.fence_code_format ''
 pymdownx.betterem:
 pymdownx.blocks.details:
 format: !!python/name:pymdownx.superfences.fence_code_format
 pymdownx.tilde:

 # pymdownx blocks
 pymdownx.blocks.admonition:
 types:
 - note
 - info
 - attention
 - caution
 - danger
 - error
 - tip
 - hint
 - warning
 - danger
 # Custom types
 - info
 pymdownx.blocks.details:
 pymdownx.blocks.tab:
 alternate_style: True

 # Other extensions
 mdx_include:

extra:
 analytics:
 provider: google
 property: G-J8HVTT936W
 feedback:
 title: Was this page helpful?
 ratings:
 - icon: material/emoticon-happy-outline
 name: This page was helpful
 data: 1
 note: >-
 Thanks for your feedback!
 - icon: material/emoticon-sad-outline
 name: This page could be improved
 data: 0
 note: >-
 Thanks for your feedback!
 social:
 - icon: fontawesome/brands/github-alt
 link: https://github.com/tiangolo/sqlmodel
Expand All@@ -161,3 +211,6 @@ extra_css:
extra_javascript:
 - js/termynal.js
 - js/custom.js

hooks:
 - scripts/mkdocs_hooks.py

3 changes: 3 additions & 0 deletions
requirements-docs-insiders.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
git+https://${TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git@9.5.30-insiders-4.53.11
git+https://${TOKEN}@github.com/pawamoy-insiders/griffe-typing-deprecated.git
git+https://${TOKEN}@github.com/pawamoy-insiders/mkdocstrings-python.git

10 changes: 5 additions & 5 deletions
requirements-docs.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
-e .
-r requirements-docs-tests.txt
mkdocs-material==9.4.7
mkdocs-material==9.5.18
mdx-include >=1.4.1,<2.0.0
mkdocs-markdownextradata-plugin >=0.1.7,<0.3.0
mkdocs-redirects>=1.2.1,<1.3.0
pyyaml >=5.3.1,<7.0.0
# For Material for MkDocs, Chinese search
jieba==0.42.1
# jieba==0.42.1
# For image processing by Material for MkDocs
pillow==10.1.0
pillow==10.3.0
# For image processing by Material for MkDocs
cairosvg==2.7.1
mkdocstrings[python]==0.25.1
# mkdocstrings[python]==0.25.1
# Enable griffe-typingdoc once dropping Python 3.7 and upgrading typing-extensions
# griffe-typingdoc==0.2.5
# For griffe, it formats with black
typer == 0.12.3
mkdocs-macros-plugin==1.0.5

17 changes: 12 additions & 5 deletions
scripts/docs.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,9 +7,6 @@
from importlib import metadata
from pathlib import Path

import mkdocs.commands.build
import mkdocs.commands.serve
import mkdocs.config
import mkdocs.utils
import typer
from jinja2 import Template
Expand DownExpand Up@@ -68,6 +65,13 @@ def generate_readme_content() -> str:
 pre_content = content[frontmatter_end:pre_end]
 post_content = content[post_start:]
 new_content = pre_content + message + post_content
 # Remove content between <!-- only-mkdocs --> and <!-- /only-mkdocs -->
 new_content = re.sub(
 r"<!-- only-mkdocs -->.*?<!-- /only-mkdocs -->",
 "",
 new_content,
 flags=re.DOTALL,
 )
 return new_content


Expand DownExpand Up@@ -111,8 +115,11 @@ def live() -> None:
 en.
 """
 # Enable line numbers during local development to make it easier to highlight
 os.environ["LINENUMS"] = "true"
 mkdocs.commands.serve.serve(dev_addr="127.0.0.1:8008")
 subprocess.run(
 ["mkdocs", "serve", "--dev-addr", "127.0.0.1:8008", "--dirty"],
 env={**os.environ, "LINENUMS": "true"},
 check=True,
 )


@app.command()
Expand Down

38 changes: 38 additions & 0 deletions
scripts/mkdocs_hooks.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
from typing import Any, List, Union

from mkdocs.config.defaults import MkDocsConfig
from mkdocs.structure.files import Files
from mkdocs.structure.nav import Link, Navigation, Section
from mkdocs.structure.pages import Page


def generate_renamed_section_items(
 items: List[Union[Page, Section, Link]], *, config: MkDocsConfig
) -> List[Union[Page, Section, Link]]:
 new_items: List[Union[Page, Section, Link]] = []
 for item in items:
 if isinstance(item, Section):
 new_title = item.title
 new_children = generate_renamed_section_items(item.children, config=config)
 first_child = new_children[0]
 if isinstance(first_child, Page):
 if first_child.file.src_path.endswith("index.md"):
 # Read the source so that the title is parsed and available
 first_child.read_source(config=config)
 new_title = first_child.title or new_title
 # Creating a new section makes it render it collapsed by default
 # no idea why, so, let's just modify the existing one
 # new_section = Section(title=new_title, children=new_children)
 item.title = new_title
 item.children = new_children
 new_items.append(item)
 else:
 new_items.append(item)
 return new_items


def on_nav(
 nav: Navigation, *, config: MkDocsConfig, files: Files, **kwargs: Any
) -> Navigation:
 new_items = generate_renamed_section_items(nav.items, config=config)
 return Navigation(items=new_items, pages=nav.pages)

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
👷 Upgrade build docs configs#1047

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.

 Sign up for GitHub

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

 Merged

tiangolo
merged 19 commits into

from

Aug 9, 2024
 Merged


👷 Upgrade build docs configs
#1047
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


19 commits


Select commit
Hold shift + click to select a range
0e63426

👷 Update build docs CI


tiangolo Aug 4, 2024
758eeac

➕ Update dependencies for docs


tiangolo Aug 4, 2024
2a80088

➕ Update dependencies


tiangolo Aug 4, 2024
2cd20d4

🔨 Update docs.py script


tiangolo Aug 4, 2024
5b6d21c

🔧 Update yaml data injection config


tiangolo Aug 4, 2024
8a7b253

🔧 Upgrade MkDocs Material configs with latest plugins and features


tiangolo Aug 5, 2024
660558d

🔨 Add section renamer based on Markdown index.md files


tiangolo Aug 5, 2024
79310ca

🔨 Update docs.py script to use mkdocs subprocess instead of internals


tiangolo Aug 5, 2024
b6512e8

🔥 Remove unused imports


tiangolo Aug 5, 2024
7c5e81a

🎨 [pre-commit.ci] Auto format from pre-commit.com hooks


pre-commit-ci[bot] Aug 5, 2024
dba4d36

🔥 Remove unneeded line


tiangolo Aug 5, 2024
88ffaef

👷 Update and simplify installing requirements from insiders


tiangolo Aug 5, 2024
ec06121

💚 Trigger CI


tiangolo Aug 5, 2024
05fdc60

🔧 Update cache keys to include insiders


tiangolo Aug 5, 2024
adfa1d8

📌 Pin mkdocs-material-insiders for now


tiangolo Aug 5, 2024
db680c4

🔨 Update custom JS scripts to run also on instant loading


tiangolo Aug 6, 2024
5da4c3f

🔥 Remove old comment


tiangolo Aug 6, 2024
18db2ae

Merge branch 'main' into mkdocs-updates


tiangolo Aug 8, 2024
9d5ada4

🔧 Update installation cache key for docs


tiangolo Aug 8, 2024

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


12 changes: 7 additions & 5 deletions
.github/workflows/build-docs.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,9 +28,12 @@ jobs:
 - docs/**
 - docs_src/**
 - requirements-docs.txt
 - requirements-docs-insiders.txt
 - pyproject.toml
 - mkdocs.yml
 - mkdocs.insiders.yml
 - mkdocs.maybe-insiders.yml
 - mkdocs.no-insiders.yml
 - .github/workflows/build-docs.yml
 - .github/workflows/deploy-docs.yml

Expand All@@ -53,16 +56,15 @@ jobs:
 id: cache
 with:
 path: ${{ env.pythonLocation }}
 key: ${{ runner.os }}-python-docs-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml', 'requirements-docs.txt') }}-v01
 key: ${{ runner.os }}-python-docs-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml', 'requirements-docs.txt', 'requirements-docs-insiders.txt', 'requirements-docs-tests.txt') }}-v02
 - name: Install docs extras
 if: steps.cache.outputs.cache-hit != 'true'
 run: pip install -r requirements-docs.txt
 - name: Install Material for MkDocs Insiders
 if: ( github.event_name != 'pull_request' || github.secret_source == 'Actions' ) && steps.cache.outputs.cache-hit != 'true'
 run: |
 pip install git+https://${{ secrets.SQLMODEL_MKDOCS_MATERIAL_INSIDERS }}@github.com/squidfunk/mkdocs-material-insiders.git
 pip install git+https://${{ secrets.SQLMODEL_MKDOCS_MATERIAL_INSIDERS }}@github.com/pawamoy-insiders/griffe-typing-deprecated.git
 pip install git+https://${{ secrets.SQLMODEL_MKDOCS_MATERIAL_INSIDERS }}@github.com/pawamoy-insiders/mkdocstrings-python.git
 run: pip install -r requirements-docs-insiders.txt
 env:
 TOKEN: ${{ secrets.SQLMODEL_MKDOCS_MATERIAL_INSIDERS }}
 - uses: actions/cache@v4
 with:
 key: mkdocs-cards-${{ github.ref }}
Expand Down

4 changes: 3 additions & 1 deletion
docs/js/custom.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -110,4 +110,6 @@ async function main() {
 setupTermynal()
}

main()
document$.subscribe(() => {
 main()
})

2 changes: 2 additions & 0 deletions
docs/tutorial/index.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
# Intro, Installation, and First Steps

Before we start playing with **SQLModel**, let's prepare everything else we need. A bit of type annotations, setting up the environment to install everything, and installing DB Browser for SQLite. 🤓

## Type hints

If you need a refresher about how to use Python type hints (type annotations), check <a href="https://fastapi.tiangolo.com/python-types/" class="external-link" target="_blank">FastAPI's Python types intro</a>.
Expand Down

6 changes: 5 additions & 1 deletion
mkdocs.insiders.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
plugins:
 social:
 typeset:
markdown_extensions:
 material.extensions.preview:
 targets:
 include:
 - ./*

89 changes: 71 additions & 18 deletions
mkdocs.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,28 +25,43 @@ theme:
 icon: material/lightbulb-outline
 name: Switch to system preference
 features:
 - search.suggest
 - search.highlight
 - content.code.annotate
 - content.code.copy
 # - content.code.select
 - content.footnote.tooltips
 - content.tabs.link
 - navigation.indexes
 - content.tooltips
 - navigation.footer
 - navigation.indexes
 - navigation.instant
 - navigation.instant.prefetch
 - navigation.instant.preview
 - navigation.instant.progress
 - navigation.path
 - content.code.annotate
 - content.code.copy
 - content.code.select
 # - navigation.tabs
 # - navigation.tabs.sticky
 - navigation.top
 - navigation.tracking
 - search.highlight
 - search.share
 - search.suggest
 - toc.follow

 icon:
 repo: fontawesome/brands/github-alt
 logo: img/icon-white.svg
 favicon: img/favicon.png
 language: en
repo_name: tiangolo/sqlmodel
repo_url: https://github.com/tiangolo/sqlmodel
edit_uri: ''
plugins:
 search: null
 markdownextradata:
 data: ./data
 # Material for MkDocs
 search:
 social:
 # Other plugins
 macros:
 include_yaml:
 - sponsors: data/sponsors.yml

nav:
 - SQLModel: index.md
Expand DownExpand Up@@ -113,33 +128,68 @@ nav:
 - release-notes.md

markdown_extensions:
 markdown.extensions.attr_list:
 markdown.extensions.tables:
 markdown.extensions.md_in_html:
 # Python Markdown
 abbr:
 attr_list:
 footnotes:
 md_in_html:
 tables:
 toc:
 permalink: true

 # Python Markdown Extensions
 pymdownx.betterem:
 smart_enable: all
 pymdownx.caret:
 pymdownx.highlight:
 line_spans: __span
 pymdownx.inlinehilite:
 pymdownx.keys:
 pymdownx.mark:
 pymdownx.superfences:
 custom_fences:
 - name: mermaid
 class: mermaid
 format: !!python/name:pymdownx.superfences.fence_code_format ''
 pymdownx.betterem:
 pymdownx.blocks.details:
 format: !!python/name:pymdownx.superfences.fence_code_format
 pymdownx.tilde:

 # pymdownx blocks
 pymdownx.blocks.admonition:
 types:
 - note
 - info
 - attention
 - caution
 - danger
 - error
 - tip
 - hint
 - warning
 - danger
 # Custom types
 - info
 pymdownx.blocks.details:
 pymdownx.blocks.tab:
 alternate_style: True

 # Other extensions
 mdx_include:

extra:
 analytics:
 provider: google
 property: G-J8HVTT936W
 feedback:
 title: Was this page helpful?
 ratings:
 - icon: material/emoticon-happy-outline
 name: This page was helpful
 data: 1
 note: >-
 Thanks for your feedback!
 - icon: material/emoticon-sad-outline
 name: This page could be improved
 data: 0
 note: >-
 Thanks for your feedback!
 social:
 - icon: fontawesome/brands/github-alt
 link: https://github.com/tiangolo/sqlmodel
Expand All@@ -161,3 +211,6 @@ extra_css:
extra_javascript:
 - js/termynal.js
 - js/custom.js

hooks:
 - scripts/mkdocs_hooks.py

3 changes: 3 additions & 0 deletions
requirements-docs-insiders.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
git+https://${TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git@9.5.30-insiders-4.53.11
git+https://${TOKEN}@github.com/pawamoy-insiders/griffe-typing-deprecated.git
git+https://${TOKEN}@github.com/pawamoy-insiders/mkdocstrings-python.git

10 changes: 5 additions & 5 deletions
requirements-docs.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
-e .
-r requirements-docs-tests.txt
mkdocs-material==9.4.7
mkdocs-material==9.5.18
mdx-include >=1.4.1,<2.0.0
mkdocs-markdownextradata-plugin >=0.1.7,<0.3.0
mkdocs-redirects>=1.2.1,<1.3.0
pyyaml >=5.3.1,<7.0.0
# For Material for MkDocs, Chinese search
jieba==0.42.1
# jieba==0.42.1
# For image processing by Material for MkDocs
pillow==10.1.0
pillow==10.3.0
# For image processing by Material for MkDocs
cairosvg==2.7.1
mkdocstrings[python]==0.25.1
# mkdocstrings[python]==0.25.1
# Enable griffe-typingdoc once dropping Python 3.7 and upgrading typing-extensions
# griffe-typingdoc==0.2.5
# For griffe, it formats with black
typer == 0.12.3
mkdocs-macros-plugin==1.0.5

17 changes: 12 additions & 5 deletions
scripts/docs.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,9 +7,6 @@
from importlib import metadata
from pathlib import Path

import mkdocs.commands.build
import mkdocs.commands.serve
import mkdocs.config
import mkdocs.utils
import typer
from jinja2 import Template
Expand DownExpand Up@@ -68,6 +65,13 @@ def generate_readme_content() -> str:
 pre_content = content[frontmatter_end:pre_end]
 post_content = content[post_start:]
 new_content = pre_content + message + post_content
 # Remove content between <!-- only-mkdocs --> and <!-- /only-mkdocs -->
 new_content = re.sub(
 r"<!-- only-mkdocs -->.*?<!-- /only-mkdocs -->",
 "",
 new_content,
 flags=re.DOTALL,
 )
 return new_content


Expand DownExpand Up@@ -111,8 +115,11 @@ def live() -> None:
 en.
 """
 # Enable line numbers during local development to make it easier to highlight
 os.environ["LINENUMS"] = "true"
 mkdocs.commands.serve.serve(dev_addr="127.0.0.1:8008")
 subprocess.run(
 ["mkdocs", "serve", "--dev-addr", "127.0.0.1:8008", "--dirty"],
 env={**os.environ, "LINENUMS": "true"},
 check=True,
 )


@app.command()
Expand Down

38 changes: 38 additions & 0 deletions
scripts/mkdocs_hooks.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
from typing import Any, List, Union

from mkdocs.config.defaults import MkDocsConfig
from mkdocs.structure.files import Files
from mkdocs.structure.nav import Link, Navigation, Section
from mkdocs.structure.pages import Page


def generate_renamed_section_items(
 items: List[Union[Page, Section, Link]], *, config: MkDocsConfig
) -> List[Union[Page, Section, Link]]:
 new_items: List[Union[Page, Section, Link]] = []
 for item in items:
 if isinstance(item, Section):
 new_title = item.title
 new_children = generate_renamed_section_items(item.children, config=config)
 first_child = new_children[0]
 if isinstance(first_child, Page):
 if first_child.file.src_path.endswith("index.md"):
 # Read the source so that the title is parsed and available
 first_child.read_source(config=config)
 new_title = first_child.title or new_title
 # Creating a new section makes it render it collapsed by default
 # no idea why, so, let's just modify the existing one
 # new_section = Section(title=new_title, children=new_children)
 item.title = new_title
 item.children = new_children
 new_items.append(item)
 else:
 new_items.append(item)
 return new_items


def on_nav(
 nav: Navigation, *, config: MkDocsConfig, files: Files, **kwargs: Any
) -> Navigation:
 new_items = generate_renamed_section_items(nav.items, config=config)
 return Navigation(items=new_items, pages=nav.pages)

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
👷 Upgrade build docs configs#1047

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.

 Sign up for GitHub

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

 Merged

tiangolo
merged 19 commits into

from

Aug 9, 2024
 Merged


👷 Upgrade build docs configs
#1047
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


19 commits


Select commit
Hold shift + click to select a range
0e63426

👷 Update build docs CI


tiangolo Aug 4, 2024
758eeac

➕ Update dependencies for docs


tiangolo Aug 4, 2024
2a80088

➕ Update dependencies


tiangolo Aug 4, 2024
2cd20d4

🔨 Update docs.py script


tiangolo Aug 4, 2024
5b6d21c

🔧 Update yaml data injection config


tiangolo Aug 4, 2024
8a7b253

🔧 Upgrade MkDocs Material configs with latest plugins and features


tiangolo Aug 5, 2024
660558d

🔨 Add section renamer based on Markdown index.md files


tiangolo Aug 5, 2024
79310ca

🔨 Update docs.py script to use mkdocs subprocess instead of internals


tiangolo Aug 5, 2024
b6512e8

🔥 Remove unused imports


tiangolo Aug 5, 2024
7c5e81a

🎨 [pre-commit.ci] Auto format from pre-commit.com hooks


pre-commit-ci[bot] Aug 5, 2024
dba4d36

🔥 Remove unneeded line


tiangolo Aug 5, 2024
88ffaef

👷 Update and simplify installing requirements from insiders


tiangolo Aug 5, 2024
ec06121

💚 Trigger CI


tiangolo Aug 5, 2024
05fdc60

🔧 Update cache keys to include insiders


tiangolo Aug 5, 2024
adfa1d8

📌 Pin mkdocs-material-insiders for now


tiangolo Aug 5, 2024
db680c4

🔨 Update custom JS scripts to run also on instant loading


tiangolo Aug 6, 2024
5da4c3f

🔥 Remove old comment


tiangolo Aug 6, 2024
18db2ae

Merge branch 'main' into mkdocs-updates


tiangolo Aug 8, 2024
9d5ada4

🔧 Update installation cache key for docs


tiangolo Aug 8, 2024

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


12 changes: 7 additions & 5 deletions
.github/workflows/build-docs.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,9 +28,12 @@ jobs:
 - docs/**
 - docs_src/**
 - requirements-docs.txt
 - requirements-docs-insiders.txt
 - pyproject.toml
 - mkdocs.yml
 - mkdocs.insiders.yml
 - mkdocs.maybe-insiders.yml
 - mkdocs.no-insiders.yml
 - .github/workflows/build-docs.yml
 - .github/workflows/deploy-docs.yml

Expand All@@ -53,16 +56,15 @@ jobs:
 id: cache
 with:
 path: ${{ env.pythonLocation }}
 key: ${{ runner.os }}-python-docs-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml', 'requirements-docs.txt') }}-v01
 key: ${{ runner.os }}-python-docs-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml', 'requirements-docs.txt', 'requirements-docs-insiders.txt', 'requirements-docs-tests.txt') }}-v02
 - name: Install docs extras
 if: steps.cache.outputs.cache-hit != 'true'
 run: pip install -r requirements-docs.txt
 - name: Install Material for MkDocs Insiders
 if: ( github.event_name != 'pull_request' || github.secret_source == 'Actions' ) && steps.cache.outputs.cache-hit != 'true'
 run: |
 pip install git+https://${{ secrets.SQLMODEL_MKDOCS_MATERIAL_INSIDERS }}@github.com/squidfunk/mkdocs-material-insiders.git
 pip install git+https://${{ secrets.SQLMODEL_MKDOCS_MATERIAL_INSIDERS }}@github.com/pawamoy-insiders/griffe-typing-deprecated.git
 pip install git+https://${{ secrets.SQLMODEL_MKDOCS_MATERIAL_INSIDERS }}@github.com/pawamoy-insiders/mkdocstrings-python.git
 run: pip install -r requirements-docs-insiders.txt
 env:
 TOKEN: ${{ secrets.SQLMODEL_MKDOCS_MATERIAL_INSIDERS }}
 - uses: actions/cache@v4
 with:
 key: mkdocs-cards-${{ github.ref }}
Expand Down

4 changes: 3 additions & 1 deletion
docs/js/custom.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -110,4 +110,6 @@ async function main() {
 setupTermynal()
}

main()
document$.subscribe(() => {
 main()
})

2 changes: 2 additions & 0 deletions
docs/tutorial/index.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
# Intro, Installation, and First Steps

Before we start playing with **SQLModel**, let's prepare everything else we need. A bit of type annotations, setting up the environment to install everything, and installing DB Browser for SQLite. 🤓

## Type hints

If you need a refresher about how to use Python type hints (type annotations), check <a href="https://fastapi.tiangolo.com/python-types/" class="external-link" target="_blank">FastAPI's Python types intro</a>.
Expand Down

6 changes: 5 additions & 1 deletion
mkdocs.insiders.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
plugins:
 social:
 typeset:
markdown_extensions:
 material.extensions.preview:
 targets:
 include:
 - ./*

89 changes: 71 additions & 18 deletions
mkdocs.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,28 +25,43 @@ theme:
 icon: material/lightbulb-outline
 name: Switch to system preference
 features:
 - search.suggest
 - search.highlight
 - content.code.annotate
 - content.code.copy
 # - content.code.select
 - content.footnote.tooltips
 - content.tabs.link
 - navigation.indexes
 - content.tooltips
 - navigation.footer
 - navigation.indexes
 - navigation.instant
 - navigation.instant.prefetch
 - navigation.instant.preview
 - navigation.instant.progress
 - navigation.path
 - content.code.annotate
 - content.code.copy
 - content.code.select
 # - navigation.tabs
 # - navigation.tabs.sticky
 - navigation.top
 - navigation.tracking
 - search.highlight
 - search.share
 - search.suggest
 - toc.follow

 icon:
 repo: fontawesome/brands/github-alt
 logo: img/icon-white.svg
 favicon: img/favicon.png
 language: en
repo_name: tiangolo/sqlmodel
repo_url: https://github.com/tiangolo/sqlmodel
edit_uri: ''
plugins:
 search: null
 markdownextradata:
 data: ./data
 # Material for MkDocs
 search:
 social:
 # Other plugins
 macros:
 include_yaml:
 - sponsors: data/sponsors.yml

nav:
 - SQLModel: index.md
Expand DownExpand Up@@ -113,33 +128,68 @@ nav:
 - release-notes.md

markdown_extensions:
 markdown.extensions.attr_list:
 markdown.extensions.tables:
 markdown.extensions.md_in_html:
 # Python Markdown
 abbr:
 attr_list:
 footnotes:
 md_in_html:
 tables:
 toc:
 permalink: true

 # Python Markdown Extensions
 pymdownx.betterem:
 smart_enable: all
 pymdownx.caret:
 pymdownx.highlight:
 line_spans: __span
 pymdownx.inlinehilite:
 pymdownx.keys:
 pymdownx.mark:
 pymdownx.superfences:
 custom_fences:
 - name: mermaid
 class: mermaid
 format: !!python/name:pymdownx.superfences.fence_code_format ''
 pymdownx.betterem:
 pymdownx.blocks.details:
 format: !!python/name:pymdownx.superfences.fence_code_format
 pymdownx.tilde:

 # pymdownx blocks
 pymdownx.blocks.admonition:
 types:
 - note
 - info
 - attention
 - caution
 - danger
 - error
 - tip
 - hint
 - warning
 - danger
 # Custom types
 - info
 pymdownx.blocks.details:
 pymdownx.blocks.tab:
 alternate_style: True

 # Other extensions
 mdx_include:

extra:
 analytics:
 provider: google
 property: G-J8HVTT936W
 feedback:
 title: Was this page helpful?
 ratings:
 - icon: material/emoticon-happy-outline
 name: This page was helpful
 data: 1
 note: >-
 Thanks for your feedback!
 - icon: material/emoticon-sad-outline
 name: This page could be improved
 data: 0
 note: >-
 Thanks for your feedback!
 social:
 - icon: fontawesome/brands/github-alt
 link: https://github.com/tiangolo/sqlmodel
Expand All@@ -161,3 +211,6 @@ extra_css:
extra_javascript:
 - js/termynal.js
 - js/custom.js

hooks:
 - scripts/mkdocs_hooks.py

3 changes: 3 additions & 0 deletions
requirements-docs-insiders.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
git+https://${TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git@9.5.30-insiders-4.53.11
git+https://${TOKEN}@github.com/pawamoy-insiders/griffe-typing-deprecated.git
git+https://${TOKEN}@github.com/pawamoy-insiders/mkdocstrings-python.git

10 changes: 5 additions & 5 deletions
requirements-docs.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
-e .
-r requirements-docs-tests.txt
mkdocs-material==9.4.7
mkdocs-material==9.5.18
mdx-include >=1.4.1,<2.0.0
mkdocs-markdownextradata-plugin >=0.1.7,<0.3.0
mkdocs-redirects>=1.2.1,<1.3.0
pyyaml >=5.3.1,<7.0.0
# For Material for MkDocs, Chinese search
jieba==0.42.1
# jieba==0.42.1
# For image processing by Material for MkDocs
pillow==10.1.0
pillow==10.3.0
# For image processing by Material for MkDocs
cairosvg==2.7.1
mkdocstrings[python]==0.25.1
# mkdocstrings[python]==0.25.1
# Enable griffe-typingdoc once dropping Python 3.7 and upgrading typing-extensions
# griffe-typingdoc==0.2.5
# For griffe, it formats with black
typer == 0.12.3
mkdocs-macros-plugin==1.0.5

17 changes: 12 additions & 5 deletions
scripts/docs.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,9 +7,6 @@
from importlib import metadata
from pathlib import Path

import mkdocs.commands.build
import mkdocs.commands.serve
import mkdocs.config
import mkdocs.utils
import typer
from jinja2 import Template
Expand DownExpand Up@@ -68,6 +65,13 @@ def generate_readme_content() -> str:
 pre_content = content[frontmatter_end:pre_end]
 post_content = content[post_start:]
 new_content = pre_content + message + post_content
 # Remove content between <!-- only-mkdocs --> and <!-- /only-mkdocs -->
 new_content = re.sub(
 r"<!-- only-mkdocs -->.*?<!-- /only-mkdocs -->",
 "",
 new_content,
 flags=re.DOTALL,
 )
 return new_content


Expand DownExpand Up@@ -111,8 +115,11 @@ def live() -> None:
 en.
 """
 # Enable line numbers during local development to make it easier to highlight
 os.environ["LINENUMS"] = "true"
 mkdocs.commands.serve.serve(dev_addr="127.0.0.1:8008")
 subprocess.run(
 ["mkdocs", "serve", "--dev-addr", "127.0.0.1:8008", "--dirty"],
 env={**os.environ, "LINENUMS": "true"},
 check=True,
 )


@app.command()
Expand Down

38 changes: 38 additions & 0 deletions
scripts/mkdocs_hooks.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
from typing import Any, List, Union

from mkdocs.config.defaults import MkDocsConfig
from mkdocs.structure.files import Files
from mkdocs.structure.nav import Link, Navigation, Section
from mkdocs.structure.pages import Page


def generate_renamed_section_items(
 items: List[Union[Page, Section, Link]], *, config: MkDocsConfig
) -> List[Union[Page, Section, Link]]:
 new_items: List[Union[Page, Section, Link]] = []
 for item in items:
 if isinstance(item, Section):
 new_title = item.title
 new_children = generate_renamed_section_items(item.children, config=config)
 first_child = new_children[0]
 if isinstance(first_child, Page):
 if first_child.file.src_path.endswith("index.md"):
 # Read the source so that the title is parsed and available
 first_child.read_source(config=config)
 new_title = first_child.title or new_title
 # Creating a new section makes it render it collapsed by default
 # no idea why, so, let's just modify the existing one
 # new_section = Section(title=new_title, children=new_children)
 item.title = new_title
 item.children = new_children
 new_items.append(item)
 else:
 new_items.append(item)
 return new_items


def on_nav(
 nav: Navigation, *, config: MkDocsConfig, files: Files, **kwargs: Any
) -> Navigation:
 new_items = generate_renamed_section_items(nav.items, config=config)
 return Navigation(items=new_items, pages=nav.pages)

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
👷 Upgrade build docs configs#1047

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.

 Sign up for GitHub

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

 Merged

tiangolo
merged 19 commits into

from

Aug 9, 2024
 Merged


👷 Upgrade build docs configs
#1047
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


19 commits


Select commit
Hold shift + click to select a range
0e63426

👷 Update build docs CI


tiangolo Aug 4, 2024
758eeac

➕ Update dependencies for docs


tiangolo Aug 4, 2024
2a80088

➕ Update dependencies


tiangolo Aug 4, 2024
2cd20d4

🔨 Update docs.py script


tiangolo Aug 4, 2024
5b6d21c

🔧 Update yaml data injection config


tiangolo Aug 4, 2024
8a7b253

🔧 Upgrade MkDocs Material configs with latest plugins and features


tiangolo Aug 5, 2024
660558d

🔨 Add section renamer based on Markdown index.md files


tiangolo Aug 5, 2024
79310ca

🔨 Update docs.py script to use mkdocs subprocess instead of internals


tiangolo Aug 5, 2024
b6512e8

🔥 Remove unused imports


tiangolo Aug 5, 2024
7c5e81a

🎨 [pre-commit.ci] Auto format from pre-commit.com hooks


pre-commit-ci[bot] Aug 5, 2024
dba4d36

🔥 Remove unneeded line


tiangolo Aug 5, 2024
88ffaef

👷 Update and simplify installing requirements from insiders


tiangolo Aug 5, 2024
ec06121

💚 Trigger CI


tiangolo Aug 5, 2024
05fdc60

🔧 Update cache keys to include insiders


tiangolo Aug 5, 2024
adfa1d8

📌 Pin mkdocs-material-insiders for now


tiangolo Aug 5, 2024
db680c4

🔨 Update custom JS scripts to run also on instant loading


tiangolo Aug 6, 2024
5da4c3f

🔥 Remove old comment


tiangolo Aug 6, 2024
18db2ae

Merge branch 'main' into mkdocs-updates


tiangolo Aug 8, 2024
9d5ada4

🔧 Update installation cache key for docs


tiangolo Aug 8, 2024

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


12 changes: 7 additions & 5 deletions
.github/workflows/build-docs.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,9 +28,12 @@ jobs:
 - docs/**
 - docs_src/**
 - requirements-docs.txt
 - requirements-docs-insiders.txt
 - pyproject.toml
 - mkdocs.yml
 - mkdocs.insiders.yml
 - mkdocs.maybe-insiders.yml
 - mkdocs.no-insiders.yml
 - .github/workflows/build-docs.yml
 - .github/workflows/deploy-docs.yml

Expand All@@ -53,16 +56,15 @@ jobs:
 id: cache
 with:
 path: ${{ env.pythonLocation }}
 key: ${{ runner.os }}-python-docs-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml', 'requirements-docs.txt') }}-v01
 key: ${{ runner.os }}-python-docs-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml', 'requirements-docs.txt', 'requirements-docs-insiders.txt', 'requirements-docs-tests.txt') }}-v02
 - name: Install docs extras
 if: steps.cache.outputs.cache-hit != 'true'
 run: pip install -r requirements-docs.txt
 - name: Install Material for MkDocs Insiders
 if: ( github.event_name != 'pull_request' || github.secret_source == 'Actions' ) && steps.cache.outputs.cache-hit != 'true'
 run: |
 pip install git+https://${{ secrets.SQLMODEL_MKDOCS_MATERIAL_INSIDERS }}@github.com/squidfunk/mkdocs-material-insiders.git
 pip install git+https://${{ secrets.SQLMODEL_MKDOCS_MATERIAL_INSIDERS }}@github.com/pawamoy-insiders/griffe-typing-deprecated.git
 pip install git+https://${{ secrets.SQLMODEL_MKDOCS_MATERIAL_INSIDERS }}@github.com/pawamoy-insiders/mkdocstrings-python.git
 run: pip install -r requirements-docs-insiders.txt
 env:
 TOKEN: ${{ secrets.SQLMODEL_MKDOCS_MATERIAL_INSIDERS }}
 - uses: actions/cache@v4
 with:
 key: mkdocs-cards-${{ github.ref }}
Expand Down

4 changes: 3 additions & 1 deletion
docs/js/custom.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -110,4 +110,6 @@ async function main() {
 setupTermynal()
}

main()
document$.subscribe(() => {
 main()
})

2 changes: 2 additions & 0 deletions
docs/tutorial/index.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
# Intro, Installation, and First Steps

Before we start playing with **SQLModel**, let's prepare everything else we need. A bit of type annotations, setting up the environment to install everything, and installing DB Browser for SQLite. 🤓

## Type hints

If you need a refresher about how to use Python type hints (type annotations), check <a href="https://fastapi.tiangolo.com/python-types/" class="external-link" target="_blank">FastAPI's Python types intro</a>.
Expand Down

6 changes: 5 additions & 1 deletion
mkdocs.insiders.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
plugins:
 social:
 typeset:
markdown_extensions:
 material.extensions.preview:
 targets:
 include:
 - ./*

89 changes: 71 additions & 18 deletions
mkdocs.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,28 +25,43 @@ theme:
 icon: material/lightbulb-outline
 name: Switch to system preference
 features:
 - search.suggest
 - search.highlight
 - content.code.annotate
 - content.code.copy
 # - content.code.select
 - content.footnote.tooltips
 - content.tabs.link
 - navigation.indexes
 - content.tooltips
 - navigation.footer
 - navigation.indexes
 - navigation.instant
 - navigation.instant.prefetch
 - navigation.instant.preview
 - navigation.instant.progress
 - navigation.path
 - content.code.annotate
 - content.code.copy
 - content.code.select
 # - navigation.tabs
 # - navigation.tabs.sticky
 - navigation.top
 - navigation.tracking
 - search.highlight
 - search.share
 - search.suggest
 - toc.follow

 icon:
 repo: fontawesome/brands/github-alt
 logo: img/icon-white.svg
 favicon: img/favicon.png
 language: en
repo_name: tiangolo/sqlmodel
repo_url: https://github.com/tiangolo/sqlmodel
edit_uri: ''
plugins:
 search: null
 markdownextradata:
 data: ./data
 # Material for MkDocs
 search:
 social:
 # Other plugins
 macros:
 include_yaml:
 - sponsors: data/sponsors.yml

nav:
 - SQLModel: index.md
Expand DownExpand Up@@ -113,33 +128,68 @@ nav:
 - release-notes.md

markdown_extensions:
 markdown.extensions.attr_list:
 markdown.extensions.tables:
 markdown.extensions.md_in_html:
 # Python Markdown
 abbr:
 attr_list:
 footnotes:
 md_in_html:
 tables:
 toc:
 permalink: true

 # Python Markdown Extensions
 pymdownx.betterem:
 smart_enable: all
 pymdownx.caret:
 pymdownx.highlight:
 line_spans: __span
 pymdownx.inlinehilite:
 pymdownx.keys:
 pymdownx.mark:
 pymdownx.superfences:
 custom_fences:
 - name: mermaid
 class: mermaid
 format: !!python/name:pymdownx.superfences.fence_code_format ''
 pymdownx.betterem:
 pymdownx.blocks.details:
 format: !!python/name:pymdownx.superfences.fence_code_format
 pymdownx.tilde:

 # pymdownx blocks
 pymdownx.blocks.admonition:
 types:
 - note
 - info
 - attention
 - caution
 - danger
 - error
 - tip
 - hint
 - warning
 - danger
 # Custom types
 - info
 pymdownx.blocks.details:
 pymdownx.blocks.tab:
 alternate_style: True

 # Other extensions
 mdx_include:

extra:
 analytics:
 provider: google
 property: G-J8HVTT936W
 feedback:
 title: Was this page helpful?
 ratings:
 - icon: material/emoticon-happy-outline
 name: This page was helpful
 data: 1
 note: >-
 Thanks for your feedback!
 - icon: material/emoticon-sad-outline
 name: This page could be improved
 data: 0
 note: >-
 Thanks for your feedback!
 social:
 - icon: fontawesome/brands/github-alt
 link: https://github.com/tiangolo/sqlmodel
Expand All@@ -161,3 +211,6 @@ extra_css:
extra_javascript:
 - js/termynal.js
 - js/custom.js

hooks:
 - scripts/mkdocs_hooks.py

3 changes: 3 additions & 0 deletions
requirements-docs-insiders.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
git+https://${TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git@9.5.30-insiders-4.53.11
git+https://${TOKEN}@github.com/pawamoy-insiders/griffe-typing-deprecated.git
git+https://${TOKEN}@github.com/pawamoy-insiders/mkdocstrings-python.git

10 changes: 5 additions & 5 deletions
requirements-docs.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
-e .
-r requirements-docs-tests.txt
mkdocs-material==9.4.7
mkdocs-material==9.5.18
mdx-include >=1.4.1,<2.0.0
mkdocs-markdownextradata-plugin >=0.1.7,<0.3.0
mkdocs-redirects>=1.2.1,<1.3.0
pyyaml >=5.3.1,<7.0.0
# For Material for MkDocs, Chinese search
jieba==0.42.1
# jieba==0.42.1
# For image processing by Material for MkDocs
pillow==10.1.0
pillow==10.3.0
# For image processing by Material for MkDocs
cairosvg==2.7.1
mkdocstrings[python]==0.25.1
# mkdocstrings[python]==0.25.1
# Enable griffe-typingdoc once dropping Python 3.7 and upgrading typing-extensions
# griffe-typingdoc==0.2.5
# For griffe, it formats with black
typer == 0.12.3
mkdocs-macros-plugin==1.0.5

17 changes: 12 additions & 5 deletions
scripts/docs.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,9 +7,6 @@
from importlib import metadata
from pathlib import Path

import mkdocs.commands.build
import mkdocs.commands.serve
import mkdocs.config
import mkdocs.utils
import typer
from jinja2 import Template
Expand DownExpand Up@@ -68,6 +65,13 @@ def generate_readme_content() -> str:
 pre_content = content[frontmatter_end:pre_end]
 post_content = content[post_start:]
 new_content = pre_content + message + post_content
 # Remove content between <!-- only-mkdocs --> and <!-- /only-mkdocs -->
 new_content = re.sub(
 r"<!-- only-mkdocs -->.*?<!-- /only-mkdocs -->",
 "",
 new_content,
 flags=re.DOTALL,
 )
 return new_content


Expand DownExpand Up@@ -111,8 +115,11 @@ def live() -> None:
 en.
 """
 # Enable line numbers during local development to make it easier to highlight
 os.environ["LINENUMS"] = "true"
 mkdocs.commands.serve.serve(dev_addr="127.0.0.1:8008")
 subprocess.run(
 ["mkdocs", "serve", "--dev-addr", "127.0.0.1:8008", "--dirty"],
 env={**os.environ, "LINENUMS": "true"},
 check=True,
 )


@app.command()
Expand Down

38 changes: 38 additions & 0 deletions
scripts/mkdocs_hooks.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
from typing import Any, List, Union

from mkdocs.config.defaults import MkDocsConfig
from mkdocs.structure.files import Files
from mkdocs.structure.nav import Link, Navigation, Section
from mkdocs.structure.pages import Page


def generate_renamed_section_items(
 items: List[Union[Page, Section, Link]], *, config: MkDocsConfig
) -> List[Union[Page, Section, Link]]:
 new_items: List[Union[Page, Section, Link]] = []
 for item in items:
 if isinstance(item, Section):
 new_title = item.title
 new_children = generate_renamed_section_items(item.children, config=config)
 first_child = new_children[0]
 if isinstance(first_child, Page):
 if first_child.file.src_path.endswith("index.md"):
 # Read the source so that the title is parsed and available
 first_child.read_source(config=config)
 new_title = first_child.title or new_title
 # Creating a new section makes it render it collapsed by default
 # no idea why, so, let's just modify the existing one
 # new_section = Section(title=new_title, children=new_children)
 item.title = new_title
 item.children = new_children
 new_items.append(item)
 else:
 new_items.append(item)
 return new_items


def on_nav(
 nav: Navigation, *, config: MkDocsConfig, files: Files, **kwargs: Any
) -> Navigation:
 new_items = generate_renamed_section_items(nav.items, config=config)
 return Navigation(items=new_items, pages=nav.pages)

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
👷 Upgrade build docs configs#1047

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.

 Sign up for GitHub

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

 Merged

tiangolo
merged 19 commits into

from

Aug 9, 2024
 Merged


👷 Upgrade build docs configs
#1047
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


19 commits


Select commit
Hold shift + click to select a range
0e63426

👷 Update build docs CI


tiangolo Aug 4, 2024
758eeac

➕ Update dependencies for docs


tiangolo Aug 4, 2024
2a80088

➕ Update dependencies


tiangolo Aug 4, 2024
2cd20d4

🔨 Update docs.py script


tiangolo Aug 4, 2024
5b6d21c

🔧 Update yaml data injection config


tiangolo Aug 4, 2024
8a7b253

🔧 Upgrade MkDocs Material configs with latest plugins and features


tiangolo Aug 5, 2024
660558d

🔨 Add section renamer based on Markdown index.md files


tiangolo Aug 5, 2024
79310ca

🔨 Update docs.py script to use mkdocs subprocess instead of internals


tiangolo Aug 5, 2024
b6512e8

🔥 Remove unused imports


tiangolo Aug 5, 2024
7c5e81a

🎨 [pre-commit.ci] Auto format from pre-commit.com hooks


pre-commit-ci[bot] Aug 5, 2024
dba4d36

🔥 Remove unneeded line


tiangolo Aug 5, 2024
88ffaef

👷 Update and simplify installing requirements from insiders


tiangolo Aug 5, 2024
ec06121

💚 Trigger CI


tiangolo Aug 5, 2024
05fdc60

🔧 Update cache keys to include insiders


tiangolo Aug 5, 2024
adfa1d8

📌 Pin mkdocs-material-insiders for now


tiangolo Aug 5, 2024
db680c4

🔨 Update custom JS scripts to run also on instant loading


tiangolo Aug 6, 2024
5da4c3f

🔥 Remove old comment


tiangolo Aug 6, 2024
18db2ae

Merge branch 'main' into mkdocs-updates


tiangolo Aug 8, 2024
9d5ada4

🔧 Update installation cache key for docs


tiangolo Aug 8, 2024

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


12 changes: 7 additions & 5 deletions
.github/workflows/build-docs.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -28,9 +28,12 @@ jobs:
 - docs/**
 - docs_src/**
 - requirements-docs.txt
 - requirements-docs-insiders.txt
 - pyproject.toml
 - mkdocs.yml
 - mkdocs.insiders.yml
 - mkdocs.maybe-insiders.yml
 - mkdocs.no-insiders.yml
 - .github/workflows/build-docs.yml
 - .github/workflows/deploy-docs.yml

Expand All@@ -53,16 +56,15 @@ jobs:
 id: cache
 with:
 path: ${{ env.pythonLocation }}
 key: ${{ runner.os }}-python-docs-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml', 'requirements-docs.txt') }}-v01
 key: ${{ runner.os }}-python-docs-${{ env.pythonLocation }}-${{ hashFiles('pyproject.toml', 'requirements-docs.txt', 'requirements-docs-insiders.txt', 'requirements-docs-tests.txt') }}-v02
 - name: Install docs extras
 if: steps.cache.outputs.cache-hit != 'true'
 run: pip install -r requirements-docs.txt
 - name: Install Material for MkDocs Insiders
 if: ( github.event_name != 'pull_request' || github.secret_source == 'Actions' ) && steps.cache.outputs.cache-hit != 'true'
 run: |
 pip install git+https://${{ secrets.SQLMODEL_MKDOCS_MATERIAL_INSIDERS }}@github.com/squidfunk/mkdocs-material-insiders.git
 pip install git+https://${{ secrets.SQLMODEL_MKDOCS_MATERIAL_INSIDERS }}@github.com/pawamoy-insiders/griffe-typing-deprecated.git
 pip install git+https://${{ secrets.SQLMODEL_MKDOCS_MATERIAL_INSIDERS }}@github.com/pawamoy-insiders/mkdocstrings-python.git
 run: pip install -r requirements-docs-insiders.txt
 env:
 TOKEN: ${{ secrets.SQLMODEL_MKDOCS_MATERIAL_INSIDERS }}
 - uses: actions/cache@v4
 with:
 key: mkdocs-cards-${{ github.ref }}
Expand Down

4 changes: 3 additions & 1 deletion
docs/js/custom.js

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -110,4 +110,6 @@ async function main() {
 setupTermynal()
}

main()
document$.subscribe(() => {
 main()
})

2 changes: 2 additions & 0 deletions
docs/tutorial/index.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
# Intro, Installation, and First Steps

Before we start playing with **SQLModel**, let's prepare everything else we need. A bit of type annotations, setting up the environment to install everything, and installing DB Browser for SQLite. 🤓

## Type hints

If you need a refresher about how to use Python type hints (type annotations), check <a href="https://fastapi.tiangolo.com/python-types/" class="external-link" target="_blank">FastAPI's Python types intro</a>.
Expand Down

6 changes: 5 additions & 1 deletion
mkdocs.insiders.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
plugins:
 social:
 typeset:
markdown_extensions:
 material.extensions.preview:
 targets:
 include:
 - ./*

89 changes: 71 additions & 18 deletions
mkdocs.yml

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -25,28 +25,43 @@ theme:
 icon: material/lightbulb-outline
 name: Switch to system preference
 features:
 - search.suggest
 - search.highlight
 - content.code.annotate
 - content.code.copy
 # - content.code.select
 - content.footnote.tooltips
 - content.tabs.link
 - navigation.indexes
 - content.tooltips
 - navigation.footer
 - navigation.indexes
 - navigation.instant
 - navigation.instant.prefetch
 - navigation.instant.preview
 - navigation.instant.progress
 - navigation.path
 - content.code.annotate
 - content.code.copy
 - content.code.select
 # - navigation.tabs
 # - navigation.tabs.sticky
 - navigation.top
 - navigation.tracking
 - search.highlight
 - search.share
 - search.suggest
 - toc.follow

 icon:
 repo: fontawesome/brands/github-alt
 logo: img/icon-white.svg
 favicon: img/favicon.png
 language: en
repo_name: tiangolo/sqlmodel
repo_url: https://github.com/tiangolo/sqlmodel
edit_uri: ''
plugins:
 search: null
 markdownextradata:
 data: ./data
 # Material for MkDocs
 search:
 social:
 # Other plugins
 macros:
 include_yaml:
 - sponsors: data/sponsors.yml

nav:
 - SQLModel: index.md
Expand DownExpand Up@@ -113,33 +128,68 @@ nav:
 - release-notes.md

markdown_extensions:
 markdown.extensions.attr_list:
 markdown.extensions.tables:
 markdown.extensions.md_in_html:
 # Python Markdown
 abbr:
 attr_list:
 footnotes:
 md_in_html:
 tables:
 toc:
 permalink: true

 # Python Markdown Extensions
 pymdownx.betterem:
 smart_enable: all
 pymdownx.caret:
 pymdownx.highlight:
 line_spans: __span
 pymdownx.inlinehilite:
 pymdownx.keys:
 pymdownx.mark:
 pymdownx.superfences:
 custom_fences:
 - name: mermaid
 class: mermaid
 format: !!python/name:pymdownx.superfences.fence_code_format ''
 pymdownx.betterem:
 pymdownx.blocks.details:
 format: !!python/name:pymdownx.superfences.fence_code_format
 pymdownx.tilde:

 # pymdownx blocks
 pymdownx.blocks.admonition:
 types:
 - note
 - info
 - attention
 - caution
 - danger
 - error
 - tip
 - hint
 - warning
 - danger
 # Custom types
 - info
 pymdownx.blocks.details:
 pymdownx.blocks.tab:
 alternate_style: True

 # Other extensions
 mdx_include:

extra:
 analytics:
 provider: google
 property: G-J8HVTT936W
 feedback:
 title: Was this page helpful?
 ratings:
 - icon: material/emoticon-happy-outline
 name: This page was helpful
 data: 1
 note: >-
 Thanks for your feedback!
 - icon: material/emoticon-sad-outline
 name: This page could be improved
 data: 0
 note: >-
 Thanks for your feedback!
 social:
 - icon: fontawesome/brands/github-alt
 link: https://github.com/tiangolo/sqlmodel
Expand All@@ -161,3 +211,6 @@ extra_css:
extra_javascript:
 - js/termynal.js
 - js/custom.js

hooks:
 - scripts/mkdocs_hooks.py

3 changes: 3 additions & 0 deletions
requirements-docs-insiders.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
git+https://${TOKEN}@github.com/squidfunk/mkdocs-material-insiders.git@9.5.30-insiders-4.53.11
git+https://${TOKEN}@github.com/pawamoy-insiders/griffe-typing-deprecated.git
git+https://${TOKEN}@github.com/pawamoy-insiders/mkdocstrings-python.git

10 changes: 5 additions & 5 deletions
requirements-docs.txt

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
-e .
-r requirements-docs-tests.txt
mkdocs-material==9.4.7
mkdocs-material==9.5.18
mdx-include >=1.4.1,<2.0.0
mkdocs-markdownextradata-plugin >=0.1.7,<0.3.0
mkdocs-redirects>=1.2.1,<1.3.0
pyyaml >=5.3.1,<7.0.0
# For Material for MkDocs, Chinese search
jieba==0.42.1
# jieba==0.42.1
# For image processing by Material for MkDocs
pillow==10.1.0
pillow==10.3.0
# For image processing by Material for MkDocs
cairosvg==2.7.1
mkdocstrings[python]==0.25.1
# mkdocstrings[python]==0.25.1
# Enable griffe-typingdoc once dropping Python 3.7 and upgrading typing-extensions
# griffe-typingdoc==0.2.5
# For griffe, it formats with black
typer == 0.12.3
mkdocs-macros-plugin==1.0.5

17 changes: 12 additions & 5 deletions
scripts/docs.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -7,9 +7,6 @@
from importlib import metadata
from pathlib import Path

import mkdocs.commands.build
import mkdocs.commands.serve
import mkdocs.config
import mkdocs.utils
import typer
from jinja2 import Template
Expand DownExpand Up@@ -68,6 +65,13 @@ def generate_readme_content() -> str:
 pre_content = content[frontmatter_end:pre_end]
 post_content = content[post_start:]
 new_content = pre_content + message + post_content
 # Remove content between <!-- only-mkdocs --> and <!-- /only-mkdocs -->
 new_content = re.sub(
 r"<!-- only-mkdocs -->.*?<!-- /only-mkdocs -->",
 "",
 new_content,
 flags=re.DOTALL,
 )
 return new_content


Expand DownExpand Up@@ -111,8 +115,11 @@ def live() -> None:
 en.
 """
 # Enable line numbers during local development to make it easier to highlight
 os.environ["LINENUMS"] = "true"
 mkdocs.commands.serve.serve(dev_addr="127.0.0.1:8008")
 subprocess.run(
 ["mkdocs", "serve", "--dev-addr", "127.0.0.1:8008", "--dirty"],
 env={**os.environ, "LINENUMS": "true"},
 check=True,
 )


@app.command()
Expand Down

38 changes: 38 additions & 0 deletions
scripts/mkdocs_hooks.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
from typing import Any, List, Union

from mkdocs.config.defaults import MkDocsConfig
from mkdocs.structure.files import Files
from mkdocs.structure.nav import Link, Navigation, Section
from mkdocs.structure.pages import Page


def generate_renamed_section_items(
 items: List[Union[Page, Section, Link]], *, config: MkDocsConfig
) -> List[Union[Page, Section, Link]]:
 new_items: List[Union[Page, Section, Link]] = []
 for item in items:
 if isinstance(item, Section):
 new_title = item.title
 new_children = generate_renamed_section_items(item.children, config=config)
 first_child = new_children[0]
 if isinstance(first_child, Page):
 if first_child.file.src_path.endswith("index.md"):
 # Read the source so that the title is parsed and available
 first_child.read_source(config=config)
 new_title = first_child.title or new_title
 # Creating a new section makes it render it collapsed by default
 # no idea why, so, let's just modify the existing one
 # new_section = Section(title=new_title, children=new_children)
 item.title = new_title
 item.children = new_children
 new_items.append(item)
 else:
 new_items.append(item)
 return new_items


def on_nav(
 nav: Navigation, *, config: MkDocsConfig, files: Files, **kwargs: Any
) -> Navigation:
 new_items = generate_renamed_section_items(nav.items, config=config)
 return Navigation(items=new_items, pages=nav.pages)