opentrons icon indicating copy to clipboard operation
opentrons copied to clipboard

feat(docs): unify CSS for multiple mkdocs projects

Open ecormany opened this issue 10 months ago • 1 comments

Overview

Adding a lil plugin so we can share one CSS file between multiple publications. You'd think this would work out of the box, but it totally doesn't!

Test Plan and Hands on Testing

tested locally, will see if this works in CI …it does!

Changelog

  • vibecoded a new plugin
  • moved opentrons-theme.css up
  • added the new plugin to Flex and Stacker docs yml
  • pointed to the new css location
  • added the plugin as editable load in uv setup

Review requests

  • where does this fit on the spectrum of kludge to elegant?
  • whomst should we list as plugin author?

Risk assessment

low. plugin code created from whole cloth by gemini but looks very straightforward.

ecormany avatar Jun 18 '25 12:06 ecormany

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 24.75%. Comparing base (981511a) to head (cc711dc). Report is 3 commits behind head on edge.

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             edge   #18670   +/-   ##
=======================================
  Coverage   24.75%   24.75%           
=======================================
  Files        3284     3284           
  Lines      285464   285416   -48     
  Branches    28663    28655    -8     
=======================================
  Hits        70662    70662           
+ Misses     214781   214733   -48     
  Partials       21       21           
Flag Coverage Δ
protocol-designer 19.04% <ø> (+<0.01%) :arrow_up:
step-generation 5.25% <ø> (+<0.01%) :arrow_up:

Flags with carried forward coverage won't be shown. Click here to find out more.

:rocket: New features to boost your workflow:
  • :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • :package: JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

codecov[bot] avatar Jun 18 '25 18:06 codecov[bot]

I kinda suggest using something that isn't setuptools because I don't think that project is very good at staying stable; the nice thing about pep517 is that you can probably drop in pdm or hatch or something just fine.

Cool, could be a future improvement. The good news is that this isn't going to be a load-bearing piece of infrastructure for us. Rather, it's going to be a tool that lets us develop one part of the docs at a time in isolation if/when rebuilding all the docs at once starts to get too heavy.

ecormany avatar Jul 02 '25 13:07 ecormany