Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR consolidates the documentation build system by merging doc/Makefile.sp (from the Sphinx starter pack) into doc/Makefile, creating a single unified Makefile for documentation builds. The changes align with Canonical-wide standard documentation tooling practices.
Key changes:
- Removes
doc/Makefile.spentirely and incorporates all its functionality intodoc/Makefile - Combines
htmlandhtml-rtdtargets using conditional logic to setLOCAL_SPHINX_BUILDdynamically - Updates
ALLFILESvariable to use.mdextensions instead of.rstfrom the start
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| doc/Makefile.sp | Complete removal of the starter pack Makefile |
| doc/Makefile | Merged implementation combining all previous functionality from both Makefiles with unified targets and variable definitions |
536b8ff to
a586fc8
Compare
a586fc8 to
3859fb2
Compare
3859fb2 to
653056a
Compare
7d4a45b to
88d0e3f
Compare
Combines doc/Makefile and doc/Makefile.sp into a single unified Makefile. All functionality is preserved, with the following improvements: - Removes prereqs for pyyaml and gitpython as these are now in static requirements.txt - Combines html and html-rtd targets with dynamic check to set LOCAL_SPHINX_BUILD=False for html-rtd - ALLFILES variable initialized to .md instead of set to .rst then changed later Signed-off-by: Minae Lee <minae.lee@canonical.com>
88d0e3f to
8ad7fdc
Compare
tomponline
approved these changes
Dec 4, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Combines doc/Makefile and doc/Makefile.sp into a single unified Makefile to move toward required standardized Canonical-wide docs tooling (the starter pack has changed to this format). All functionality is preserved, with the following improvements:
pyyamlandgitpythonas these are now in staticrequirements.txthtmlandhtml-rtdtargets with dynamic check to setLOCAL_SPHINX_BUILD=Falseforhtml-rtdALLFILESvariable initialized to .md instead of set to .rst then changed laterChecklist