Skip to content

Enhance CLI documentation tool and streamline project setup#2

Merged
coordt merged 16 commits intomainfrom
implementation
Mar 31, 2026
Merged

Enhance CLI documentation tool and streamline project setup#2
coordt merged 16 commits intomainfrom
implementation

Conversation

@coordt
Copy link
Copy Markdown
Member

@coordt coordt commented Mar 31, 2026

Summary

This pull request introduces several enhancements and newly added features aimed at improving project automation, documentation, and functionality:

  • Updates GitHub Actions workflows for improved Python compatibility and documentation deployment using Zensical.
  • Adds a CLI tool for generating Markdown documentation for Click apps, supporting nested commands, customizable Markdown output, and configuration via pyproject.toml.
  • Refactors the CLI tool for better modularity, readability, and error handling.
  • Introduces support for loading modules with relative imports and verifies compatibility via new test fixtures.
  • Updates the project's Python compatibility matrix and switches the license to Apache 2.0.

Changes

Documentation

  • Adds a GitHub Actions workflow (docs.yml) to deploy project documentation utilizing GitHub Pages. This includes:
    • Initialization of Zensical for customizable documentation builds.
    • Custom CSS for improved documentation styling.
    • Placeholders for future assets (e.g., images).
    • ReadMe updates for clear installation, usage, and contribution methods.

CLI Enhancements:

  • Implements auto-applied CLI behavior (via pyproject.toml) for Markdown quality settings such as customization of:
    • Style layouts
    • TOC control visibility management

coordt and others added 12 commits March 29, 2026 10:35
…yles (plain/table), and program name override
… exclusion, hidden commands/options, TOC generation, and ASCII art removal.
…ed CLI defaults for header depth, style, exclusion, and more.
…etup for project documentation site

- Add `docs.yml` workflow for deploying docs to GitHub Pages.
- Introduce Zensical configuration (`zensical.toml`) for site customization and structure.
- Add CLI reference documentation and API reference files for core modules.
- Include custom CSS files for enhanced documentation styling.
- Update `README.md` with installation, usage, and contribution guidelines.
- Add a placeholder image directory and empty `.gitkeep` file.
Bumps the github-actions group with 9 updates:

| Package | From | To |
| --- | --- | --- |
| [actions/checkout](https://github.com/actions/checkout) | `4` | `6` |
| [actions/download-artifact](https://github.com/actions/download-artifact) | `4` | `8` |
| [actions/setup-python](https://github.com/actions/setup-python) | `5` | `6` |
| [astral-sh/setup-uv](https://github.com/astral-sh/setup-uv) | `5` | `7` |
| [github/codeql-action](https://github.com/github/codeql-action) | `3` | `4` |
| [docker/login-action](https://github.com/docker/login-action) | `3` | `4` |
| [docker/metadata-action](https://github.com/docker/metadata-action) | `5` | `6` |
| [docker/build-push-action](https://github.com/docker/build-push-action) | `6` | `7` |
| [actions/attest-build-provenance](https://github.com/actions/attest-build-provenance) | `2` | `4` |


Updates `actions/checkout` from 4 to 6
- [Release notes](https://github.com/actions/checkout/releases)
- [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md)
- [Commits](actions/checkout@v4...v6)

Updates `actions/download-artifact` from 4 to 8
- [Release notes](https://github.com/actions/download-artifact/releases)
- [Commits](actions/download-artifact@v4...v8)

Updates `actions/setup-python` from 5 to 6
- [Release notes](https://github.com/actions/setup-python/releases)
- [Commits](actions/setup-python@v5...v6)

Updates `astral-sh/setup-uv` from 5 to 7
- [Release notes](https://github.com/astral-sh/setup-uv/releases)
- [Commits](astral-sh/setup-uv@v5...v7)

Updates `github/codeql-action` from 3 to 4
- [Release notes](https://github.com/github/codeql-action/releases)
- [Changelog](https://github.com/github/codeql-action/blob/main/CHANGELOG.md)
- [Commits](github/codeql-action@v3...v4)

Updates `docker/login-action` from 3 to 4
- [Release notes](https://github.com/docker/login-action/releases)
- [Commits](docker/login-action@v3...v4)

Updates `docker/metadata-action` from 5 to 6
- [Release notes](https://github.com/docker/metadata-action/releases)
- [Commits](docker/metadata-action@v5...v6)

Updates `docker/build-push-action` from 6 to 7
- [Release notes](https://github.com/docker/build-push-action/releases)
- [Commits](docker/build-push-action@v6...v7)

Updates `actions/attest-build-provenance` from 2 to 4
- [Release notes](https://github.com/actions/attest-build-provenance/releases)
- [Changelog](https://github.com/actions/attest-build-provenance/blob/main/RELEASE.md)
- [Commits](actions/attest-build-provenance@v2...v4)

---
updated-dependencies:
- dependency-name: actions/checkout
  dependency-version: '6'
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: github-actions
- dependency-name: actions/download-artifact
  dependency-version: '8'
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: github-actions
- dependency-name: actions/setup-python
  dependency-version: '6'
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: github-actions
- dependency-name: astral-sh/setup-uv
  dependency-version: '7'
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: github-actions
- dependency-name: github/codeql-action
  dependency-version: '4'
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: github-actions
- dependency-name: docker/login-action
  dependency-version: '4'
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: github-actions
- dependency-name: docker/metadata-action
  dependency-version: '6'
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: github-actions
- dependency-name: docker/build-push-action
  dependency-version: '7'
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: github-actions
- dependency-name: actions/attest-build-provenance
  dependency-version: '4'
  dependency-type: direct:production
  update-type: version-update:semver-major
  dependency-group: github-actions
...

Signed-off-by: dependabot[bot] <support@github.com>
@github-actions
Copy link
Copy Markdown
Contributor

github-actions bot commented Mar 31, 2026

PR Preview Action v1.8.1
Preview removed because the pull request was closed.
2026-03-31 16:23 UTC

@github-actions
Copy link
Copy Markdown
Contributor

Version hint: minor
Current version: 0.1.0
New version (when merged): 0.2.0

Comment ID: Display version hint-auto-generated

@coordt coordt merged commit fa7a6d0 into main Mar 31, 2026
10 checks passed
@coordt coordt deleted the implementation branch March 31, 2026 16:22
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.

1 participant