Skip to content

doc: update to sync with microceph adoption of sphinx-starter-pack - #839

Merged
roosterfish merged 2 commits into
canonical:mainfrom
minaelee:fix-microceph-header
Jun 30, 2025
Merged

doc: update to sync with microceph adoption of sphinx-starter-pack#839
roosterfish merged 2 commits into
canonical:mainfrom
minaelee:fix-microceph-header

Conversation

@minaelee

Copy link
Copy Markdown

MicroCeph's recent adoption of the Sphinx Starter Pack meant changes to its config file to where our MicroCeph integration was no longer compatible. This PR updates our MicroCeph integration, including:

  • Updates the Makefile to create folders that no longer exist in the standalone but are needed by the integration
  • Updates the Makefile to use conf.py instead of custom_conf.py for the MicroCeph configuration file
  • Adds a new override-header.css file because sphinx-starter-pack overwrites the header.css file (via the canonical-sphinx extension that it uses). This override-header.css file only includes the CSS rules we need to change, modified for higher specificity to override the sphinx-starter-pack's header.css.
  • Updates add_config.py to use new variable names in conf.py.

Minae Lee added 2 commits June 27, 2025 16:01
Signed-off-by: Minae Lee <minae.lee@canonical.com>
…er-pack

Signed-off-by: Minae Lee <minae.lee@canonical.com>
@github-actions github-actions Bot added the Documentation Documentation needs updating label Jun 27, 2025
@minaelee
minaelee marked this pull request as ready for review June 29, 2025 19:02

@roosterfish roosterfish left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thank you, looking great!

@roosterfish
roosterfish merged commit d57ca2d into canonical:main Jun 30, 2025
14 checks passed
roosterfish added a commit that referenced this pull request Jul 4, 2025
This reverts one of the commits in
#839 as the links are now
skipped generally.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Documentation needs updating

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants