Skip to content

Commit d546d29

Browse files
CopilotEH-MLSDanielAvdar
authored
[WIP] Fix documentation so that 'make doctest' passes (#191)
* Initial plan for issue * Fix doctest target and resolve sphinx warnings Co-authored-by: eh-main-bot <171766998+eh-main-bot@users.noreply.github.com> * Update Read the Docs configuration to use Ubuntu LTS and Python 3.12 * Address code review feedback on doctest target and _static directory Co-authored-by: eh-main-bot <171766998+eh-main-bot@users.noreply.github.com> * Remove unnecessary doctest command line as requested in code review Co-authored-by: eh-main-bot <171766998+eh-main-bot@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: eh-main-bot <171766998+eh-main-bot@users.noreply.github.com> Co-authored-by: Daniel Avdar <66269169+DanielAvdar@users.noreply.github.com>
1 parent c62a673 commit d546d29

File tree

3 files changed

+8
-11
lines changed

3 files changed

+8
-11
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -117,3 +117,6 @@ venv.bak/
117117

118118
# PyCharm
119119
.idea/
120+
121+
# Generated test files
122+
kfp_functions.py

.readthedocs.yaml

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,10 @@ formats: all
1313

1414
# Set the OS, Python version, and other tools you might need
1515
build:
16-
os: "ubuntu-22.04"
16+
os: ubuntu-lts-latest
1717
tools:
18-
python: "3.10"
18+
python: "3.12"
1919
jobs:
20-
post_create_environment:
21-
# Install poetry
22-
# https://python-poetry.org/docs/#installing-manually
23-
- pip install poetry
2420
post_install:
25-
# Install dependencies with 'docs' dependency group
26-
# https://python-poetry.org/docs/managing-dependencies/#dependency-groups
27-
# VIRTUAL_ENV needs to be set manually for now, see #11150
28-
- VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install
21+
- pip install uv
22+
- UV_PROJECT_ENVIRONMENT=$READTHEDOCS_VIRTUALENV_PATH uv sync --group docs --link-mode=copy --frozen --no-group dev

docs/source/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,4 +39,4 @@
3939
# -- Options for HTML output -------------------------------------------------
4040
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
4141

42-
html_static_path = ["_static"]
42+
html_static_path = []

0 commit comments

Comments
 (0)