Skip to content

fix(docs): update docs and resolve build errors#35

Merged
haillew merged 3 commits into
databricks-solutions:mainfrom
lp-ae:fix/update-docs-resolve-errors
Apr 17, 2026
Merged

fix(docs): update docs and resolve build errors#35
haillew merged 3 commits into
databricks-solutions:mainfrom
lp-ae:fix/update-docs-resolve-errors

Conversation

@lp-ae

@lp-ae lp-ae commented Apr 14, 2026

Copy link
Copy Markdown
Contributor

Updates the pipeline build documentation to better reflect naming migration to SDP and default Lakeflow Framework bundle deployment location. Along the way discovered doco building was failing for both HTML and md versions, so I've fixed those too (fixes #36).

There are a couple of notable points that probably need further thought;

  • Docutils version pinning resolves a sphinx-tabs backrefs build error as described in Issue#206. This is resolved by PR#207 and released in v3.5.0 however there is an incompatibility resolving dependencies with sphinx-toolbox v4.1.2 which depends on sphinx-tabs>=1.2.1,<3.4.7. Ideally all reqs should have their versions pinned for consistency, however that's outside the scope of this PR.
  • Additional config params bring the config up to date with sphinx-markdown-builder>=0.6.9 accounting for breaking changes introduced by PR#40
  • The rest are resolutions to formatting issues throwing errors, however there are still a significant number of warnings (270+) that should probably be resolved. Notable among them are toctree orphans and duplicate labels.

The issues discovered also pretty strongly indicate that package pinning is a good idea, this will likely break again in future. Might also be a good idea to build the docs as part of a pass-required CI activity on PRs if the intention is to keep doco aligned with features.

@liamperritt liamperritt requested a review from haillew April 17, 2026 00:54
@rederik76 rederik76 changed the title Fix: update docs and resolve build errors fix(docs): update docs and resolve build errors Apr 17, 2026

@haillew haillew left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

LGTM - thanks Lincoln

@haillew haillew merged commit b465f75 into databricks-solutions:main Apr 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[BUG]: Docs generation failing

3 participants