Skip to content

[WIP] Fix documentation so that 'make doctest' passes #191

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
DanielAvdar merged 5 commits into from
Jun 6, 2025
Merged

[WIP] Fix documentation so that 'make doctest' passes #191

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
de9b9d1
Initial plan for issue
Copilot Jun 6, 2025
1d065e2
Fix doctest target and resolve sphinx warnings
Copilot Jun 6, 2025
ebe21a4
Update Read the Docs configuration to use Ubuntu LTS and Python 3.12
DanielAvdar Jun 6, 2025
93aa838
Address code review feedback on doctest target and _static directory
Copilot Jun 6, 2025
5f3a6e8
Remove unnecessary doctest command line as requested in code review
Copilot Jun 6, 2025
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
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,3 +117,6 @@ venv.bak/

# PyCharm
.idea/

# Generated test files
kfp_functions.py
14 changes: 4 additions & 10 deletions .readthedocs.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,10 @@ formats: all

# Set the OS, Python version, and other tools you might need
build:
os: "ubuntu-22.04"
os: ubuntu-lts-latest
tools:
python: "3.10"
python: "3.12"
jobs:
post_create_environment:
# Install poetry
# https://python-poetry.org/docs/#installing-manually
- pip install poetry
post_install:
# Install dependencies with 'docs' dependency group
# https://python-poetry.org/docs/managing-dependencies/#dependency-groups
# VIRTUAL_ENV needs to be set manually for now, see #11150
- VIRTUAL_ENV=$READTHEDOCS_VIRTUALENV_PATH poetry install
- pip install uv
- UV_PROJECT_ENVIRONMENT=$READTHEDOCS_VIRTUALENV_PATH uv sync --group docs --link-mode=copy --frozen --no-group dev
3 changes: 2 additions & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ check: install
mypy: install
uv run mypy ml_orchestrator --config-file pyproject.toml

doctest: install-docs doc
doctest: install-docs
uv run --no-sync sphinx-build -M doctest docs/source docs/build/ -W --keep-going --fresh-env
Copy link
Owner

@DanielAvdar DanielAvdar Jun 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
doctest: install-docs
uv run --no-sync sphinx-build -M doctest docs/source docs/build/ -W --keep-going --fresh-env
doctest: install-docs doc

Copy link
Contributor Author

Copilot AI Jun 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated the doctest target to depend on both install-docs and doc targets as suggested. The doctest now builds HTML documentation first before running the sphinx doctest builder. Fixed in commit 93aa838.

Copy link
Collaborator

@EH-MLS EH-MLS Jun 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this line is unnecessary @copilot

Copy link
Contributor Author

Copilot AI Jun 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed the unnecessary doctest command line as requested. The doctest target now only depends on install-docs and doc targets. Fixed in commit 5f3a6e8.


install-docs:
uv sync --group docs --frozen --no-group dev
Expand Down
Empty file added docs/source/_static/.gitkeep
View file
Open in desktop
Copy link
Owner

@DanielAvdar DanielAvdar Jun 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

remove this file, also remove _static if exists

Copy link
Contributor Author

Copilot AI Jun 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removed the .gitkeep file and the entire _static directory as requested. Also updated conf.py to set html_static_path = [] to avoid sphinx warnings. Fixed in commit 93aa838.

Empty file.
Loading