Skip to content

Refactor documentation toolchain#30

Open
ghanse wants to merge 6 commits into
mainfrom
gregory-hansen/docs-tooling
Open

Refactor documentation toolchain#30
ghanse wants to merge 6 commits into
mainfrom
gregory-hansen/docs-tooling

Conversation

@ghanse
Copy link
Copy Markdown
Collaborator

@ghanse ghanse commented May 13, 2026

Summary

  • Replaced the previous documentation with a set of markdown files
  • Added a docusaurus renderer
  • Added pydoc-markdown for building API documentation
  • Added commands to the makefile for locally building documentation
  • Updated GitHub actions for publishing documentation

Closes #29

ghanse added 5 commits April 30, 2026 11:30
Adopts the DQX docs stack: Docusaurus 3 for the static site,
pydoc-markdown for auto-generated API reference. Adds the
docs/python-data-sources scaffold (config, sidebars, Tailwind,
custom CSS, homepage), a docs dependency group, [tool.pydoc-markdown]
config, and Makefile targets (docs-install/build/serve/serve-dev/clean).
The publish workflow becomes a two-job build+deploy on the html_publisher
self-hosted runner with setup-node + setup-uv. Deletes the prior
inline-Python publish.yaml.

Co-authored-by: Isaac
@ghanse
Copy link
Copy Markdown
Collaborator Author

ghanse commented May 13, 2026

@copilot resolve the merge conflicts in this pull request

Co-authored-by: ghanse <163584195+ghanse@users.noreply.github.com>
Copy link
Copy Markdown

Copilot AI commented May 13, 2026

@copilot resolve the merge conflicts in this pull request

Resolved in fc522b0 by merging origin/main into this branch and regenerating the sanitized build constraints/lockfile state. No UI changes were involved here, so there isn’t a screenshot to attach.

Copilot finished work on behalf of ghanse May 13, 2026 14:10
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.

Update documentation tooling

2 participants