Skip to content

Commit d55469f

Browse files
committed
ci(docs): update configuration and add template
- Add exclusions and adjust type checking rules in pyrightconfig - Improve ReadTheDocs build configuration with additional steps - Add main.html template for better ReadTheDocs integration - Use frozen dependencies in ReadTheDocs builds for consistency
1 parent bc141f4 commit d55469f

3 files changed

Lines changed: 25 additions & 9 deletions

File tree

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,15 @@
11
{
22
"$schema": "https://raw.githubusercontent.com/microsoft/pyright/main/packages/vscode-pyright/schemas/pyrightconfig.schema.json",
33

4+
"exclude": ["**/node_modules", "**/__pycache__", "**/.*", "marimo/"],
5+
46
"enableTypeIgnoreComments": false,
57

68
"typeCheckingMode": "standard",
79

810
"reportArgumentType": "information",
911
"reportAssignmentType": "information",
10-
"reportPrivateImportUsage": "none",
11-
"reportRedeclaration": "none"
12+
"reportRedeclaration": "none",
13+
"reportIncompatibleMethodOverride": "warning",
14+
"reportIncompatibleVariableOverride": "warning"
1215
}

template/.readthedocs.yaml.jinja

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,22 @@
22
# yaml-language-server: $schema=https://raw.githubusercontent.com/readthedocs/readthedocs.org/master/readthedocs/rtd_tests/fixtures/spec/v2/schema.json
33
# This file is @generated by <https://github.com/liblaf/copier-python>.
44
# DO NOT EDIT!
5+
56
# ref: <https://docs.readthedocs.com/platform/stable/config-file/v2.html>
67
# ref: <https://docs.readthedocs.com/platform/stable/reference/environment-variables.html>
78

89
version: 2
910

10-
python:
11-
install:
12-
- requirements: requirements.txt
13-
1411
build:
1512
os: ubuntu-lts-latest
1613
tools:
1714
python: latest
1815
jobs:
16+
post_checkout:
17+
# ref: <https://docs.readthedocs.com/platform/stable/build-customization.html#unshallow-git-clone>
18+
- git fetch --unshallow || true
19+
20+
# ref: <https://docs.readthedocs.com/platform/stable/build-customization.html#install-dependencies-with-uv>
1921
pre_create_environment:
2022
# {%- if package_manager == "pixi" %}
2123
- asdf plugin add pixi
@@ -29,14 +31,14 @@ build:
2931

3032
# {%- if package_manager == "uv" %}
3133
create_environment:
32-
- uv venv "$READTHEDOCS_VIRTUALENV_PATH"
34+
- uv venv "${READTHEDOCS_VIRTUALENV_PATH}"
3335
# {%- endif %}
3436

3537
install:
3638
# {%- if package_manager == "pixi" %}
37-
- pixi install
39+
- pixi install --frozen
3840
# {%- elif package_manager == "uv" %}
39-
- UV_PROJECT_ENVIRONMENT="$READTHEDOCS_VIRTUALENV_PATH" uv sync --all-extras --all-groups --link-mode copy
41+
- UV_PROJECT_ENVIRONMENT="${READTHEDOCS_VIRTUALENV_PATH}" uv sync --all-extras --all-groups --frozen --link-mode copy
4042
# {%- endif %}
4143

4244
pre_build:

template/docs/overrides/main.html

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- This file is @generated by <https://github.com/liblaf/copier-python>. -->
2+
<!-- DO NOT EDIT! -->
3+
4+
<!-- ref: <https://docs.readthedocs.com/platform/stable/intro/mkdocs.html#integrate-the-read-the-docs-version-menu-into-your-site-navigation> -->
5+
<!-- prettier-ignore -->
6+
{% extends "base.html" %}
7+
8+
{% block site_meta %}
9+
{{ super() }}
10+
<meta name="readthedocs-addons-api-version" content="1" />
11+
{% endblock %}

0 commit comments

Comments
 (0)