Refactor documentation toolchain#30
Open
ghanse wants to merge 6 commits into
Open
Conversation
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
Collaborator
Author
|
@copilot resolve the merge conflicts in this pull request |
Co-authored-by: ghanse <163584195+ghanse@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Refactors the repository documentation toolchain by moving to a Docusaurus-based docs site and generating API reference docs via pydoc-markdown, along with updated local Makefile targets and a refreshed GitHub Pages publishing workflow (closes #29).
Changes:
- Adds a Docusaurus site under
docs/python-data-sources/(config, pages, styling, assets). - Introduces
pydoc-markdownconfiguration + adocsdependency group for API doc generation. - Replaces the legacy GitHub Pages workflow with a new build+deploy pipeline.
Reviewed changes
Copilot reviewed 25 out of 28 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
uv.lock |
Adds locked dependencies for the new docs group (notably pydoc-markdown and transitive deps). |
pyproject.toml |
Adds docs dependency group and pydoc-markdown config targeting Docusaurus output. |
Makefile |
Adds docs-* targets for installing/building/serving/cleaning docs; updates lock verification message. |
docs/python-data-sources/tsconfig.json |
Adds editor-friendly TS config for the docs site. |
docs/python-data-sources/tailwind.config.ts |
Adds Tailwind configuration for docs styling. |
docs/python-data-sources/static/img/logo.svg |
Adds a placeholder logo asset for the docs site. |
docs/python-data-sources/static/.nojekyll |
Ensures GitHub Pages serves files without Jekyll processing. |
docs/python-data-sources/src/pages/index.tsx |
Adds a custom Docusaurus homepage. |
docs/python-data-sources/src/css/custom.css |
Adds global CSS, Tailwind directives, and site styling tweaks. |
docs/python-data-sources/src/components/Button.tsx |
Adds a reusable button/link component for the docs UI. |
docs/python-data-sources/sidebars.ts |
Enables autogenerated sidebars from the docs folder structure. |
docs/python-data-sources/package.json |
Defines the Docusaurus site dependencies and scripts. |
docs/python-data-sources/docusaurus.config.ts |
Adds Docusaurus site configuration (baseUrl, plugins, theming, navbar/footer). |
docs/python-data-sources/docs/reference/index.mdx |
Adds the top-level Reference section page. |
docs/python-data-sources/docs/reference/api/zipdcm/zip_dcm_utils.md |
Adds generated API reference content for zipdcm.zip_dcm_utils. |
docs/python-data-sources/docs/reference/api/zipdcm/zip_dcm_ds.md |
Adds generated API reference content for zipdcm datasource classes. |
docs/python-data-sources/docs/reference/api/sidebar.json |
Adds a generated API sidebar artifact. |
docs/python-data-sources/docs/reference/api/mqtt/mqtt_streaming.md |
Adds generated API reference content for MQTT streaming datasource. |
docs/python-data-sources/docs/reference/api/mcap/mcap_datasource.md |
Adds generated API reference content for MCAP datasource. |
docs/python-data-sources/docs/reference/api/index.mdx |
Adds an API Reference landing page. |
docs/python-data-sources/docs/reference/api/common/range_partition.md |
Adds generated API reference content for common partitions. |
docs/python-data-sources/docs/motivation.mdx |
Adds a Motivation page describing the project and connectors. |
docs/python-data-sources/docs/installation.mdx |
Adds Installation docs for optional extras and datasource registration. |
docs/python-data-sources/docs/demos.mdx |
Adds a Demos page linking to example notebooks. |
docs/python-data-sources/.gitignore |
Ignores docs build artifacts and generated API output within the docs workspace. |
.github/workflows/publish.yml |
New GitHub Pages pipeline to build Docusaurus (uv + yarn) and deploy. |
.github/workflows/publish.yaml |
Removes the previous notebook-to-HTML single-page publish workflow. |
.build-constraints.txt |
Updates build constraints (trove-classifiers version bump). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+43
to
+62
| const destination = disabled ? null : link; | ||
| return ( | ||
| <Link to={destination} className={linkClassName}> | ||
| <button | ||
| className={clsx( | ||
| 'btn', | ||
| 'button', | ||
| sizeClass, | ||
| outlineClass, | ||
| variantClass, | ||
| blockClass, | ||
| disabledClass, | ||
| className, | ||
| )} | ||
| style={style} | ||
| role='button' | ||
| aria-disabled={disabled} | ||
| > | ||
| {label} | ||
| </button> |
Comment on lines
+60
to
+66
| yarn --cwd docs/python-data-sources install --frozen-lockfile | ||
|
|
||
| docs-build: | ||
| uv run --group docs pydoc-markdown | ||
| yarn --cwd docs/python-data-sources build | ||
|
|
||
| docs-serve-dev: |
Comment on lines
+33
to
+42
| - name: Setup Node.js | ||
| uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f # v6.3.0 | ||
| with: | ||
| node-version: 22 | ||
| cache: yarn | ||
| cache-dependency-path: docs/python-data-sources/yarn.lock | ||
|
|
||
| - name: Install docs dependencies | ||
| run: make docs-install | ||
|
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Closes #29