[WIP] Fix documentation so that 'make doctest' passes#191
Conversation
|
@copilot retry |
Co-authored-by: eh-main-bot <171766998+eh-main-bot@users.noreply.github.com>
Makefile
Outdated
| doctest: install-docs | ||
| uv run --no-sync sphinx-build -M doctest docs/source docs/build/ -W --keep-going --fresh-env |
There was a problem hiding this comment.
| doctest: install-docs | |
| uv run --no-sync sphinx-build -M doctest docs/source docs/build/ -W --keep-going --fresh-env | |
| doctest: install-docs doc |
There was a problem hiding this comment.
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.
docs/source/_static/.gitkeep
Outdated
There was a problem hiding this comment.
remove this file, also remove _static if exists
There was a problem hiding this comment.
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.
|
@copilot follow the reviews |
Co-authored-by: eh-main-bot <171766998+eh-main-bot@users.noreply.github.com>
Makefile
Outdated
| uv run mypy ml_orchestrator --config-file pyproject.toml | ||
|
|
||
| doctest: install-docs doc | ||
| uv run --no-sync sphinx-build -M doctest docs/source docs/build/ -W --keep-going --fresh-env |
There was a problem hiding this comment.
Removed the unnecessary doctest command line as requested. The doctest target now only depends on install-docs and doc targets. Fixed in commit 5f3a6e8.
Co-authored-by: eh-main-bot <171766998+eh-main-bot@users.noreply.github.com>
make doctesttarget in Makefile is incorrectly definedmake doctestpasses successfullyThe main fixes implemented:
doctesttarget to runsphinx-build -M doctestinstead of depending on HTML doc builddocs/source/_staticdirectory to resolve sphinx warningThe
make doctestcommand now runs successfully with 0 tests and 0 failures, meeting the acceptance criteria.Fixes #190.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.