Skip to content

build(docs)!: incorporate Ulwazi 1.0 - #650

Merged
jahn-junior merged 9 commits into
mainfrom
work/ulwazi/DOCPR-2713
Oct 17, 2026
Merged

jahn-junior merged 9 commits into
mainfrom
work/ulwazi/DOCPR-2713

Conversation

@jahn-junior

@jahn-junior jahn-junior commented Oct 14, 2026 •

Copy link
Copy Markdown
Collaborator

Bring in Ulwazi as the default theme for Sphinx Stack 3.0 and higher. Marking as breaking because this introduces new potential failure points for documentation projects.

  • Removes custom templates that are now incompatible
  • Remove unused html_title declaration
  • Append " documentation" to project, as it's no longer visible in the banner or above the global nav
  • Drops explicit notfound dependency, as it's now set up by Ulwazi
  • Adds myst-parser to extensions, as it's no longer set up by canonical-sphinx

Note for reviewers: You'll have to check out and build locally to validate the changes. I'm mainly looking for feedback on the default configuration of the banner (link text, destination URLs, and so on).


  • Have you updated CHANGELOG.md?
  • Have you updated the documentation to reflect your changes?

Comment thread docs/conf.py
Comment thread docs/requirements.txt Outdated
@jahn-junior
jahn-junior requested a review from izmalk October 15, 2026 00:28
@jahn-junior jahn-junior changed the title build(docs): incorporate Ulwazi 1.0 build(docs)!: incorporate Ulwazi 1.0 Oct 15, 2026
@izmalk

izmalk commented Oct 16, 2026 •

Copy link
Copy Markdown
Contributor

There is no Preview PR build here, which is weird. It would be helpful to test a few RTD-specific features, like Feedback links.

@jahn-junior

jahn-junior commented Oct 16, 2026 •

Copy link
Copy Markdown
Collaborator Author

@izmalk

There is no Preview PR build here, which is weird. It would be helpful to test a few RTD-specific features, like Feedback links.

It's because the RTD project is sourced from the sphinx-stack-docs repo. I'll create a new RTD project for testing changes here when I have some downtime. For these changes, I'd ask that you validate what you can without it, and we can ensure everything works when I update the docs repo to 3.0 (hopefully later today if I can get this merged).

@izmalk

izmalk commented Oct 16, 2026

Copy link
Copy Markdown
Contributor

I'd ask that you validate what you can without it

Yes, I'm working on it.
So far everything seems to be mostly OK. There is a MyST extensions fix that I'm implementing into Ulwazi.
Other than that, a few minor things, including some stale comments in conf.py

Comment thread docs/conf.py Outdated
Comment thread docs/conf.py
@jahn-junior
jahn-junior requested a review from izmalk October 17, 2026 00:08

@izmalk izmalk 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.

LGTM

@jahn-junior jahn-junior added awaiting release Will be merged for the next minor release. breaking change PR introduces a breaking change. labels Oct 17, 2026
@jahn-junior
jahn-junior merged commit a382ccd into main Oct 17, 2026
8 checks passed
@jahn-junior
jahn-junior deleted the work/ulwazi/DOCPR-2713 branch October 17, 2026 02:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

awaiting release Will be merged for the next minor release. breaking change PR introduces a breaking change.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants