Skip to content

Python/mkdocs init#257

Merged
alexluck-sift merged 25 commits intomainfrom
python/mkdocs-init
Aug 27, 2025
Merged

Python/mkdocs init#257
alexluck-sift merged 25 commits intomainfrom
python/mkdocs-init

Conversation

@alexluck-sift
Copy link
Collaborator

@alexluck-sift alexluck-sift commented Jun 27, 2025

Adds mkdocs to the project for building documentation.

  • Implements mike for documentation versioning.
  • Created github actions for deploying docs to Github pages. Each new version deployed to pypi will generate a new doc version, but only major.minor.patch formatted versions are visible in the drop down. The PATCH portion of the version is omitted from the docs version.
  • PRs will be published as doc versions, but hidden. Upon PR closure, old PR doc versions should be cleaned up.
  • Hidden doc versions can be accessed via direct links.

Docs branch
The gh-pages branch contains the Github pages content.

The python folder contains all doc versions. In the future, we may publish documentation for different client libraries by publishing them to other root folders in the repo.

VIEW THE DOCS

@alexluck-sift alexluck-sift marked this pull request as ready for review August 21, 2025 19:18
Copy link
Contributor

@ian-sift ian-sift left a comment

Choose a reason for hiding this comment

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

seems solid and we can always iterate on nitty-gritty later. just a few minor questions and comments.

ian-sift
ian-sift previously approved these changes Aug 27, 2025
@alexluck-sift alexluck-sift requested a review from ian-sift August 27, 2025 22:45
@alexluck-sift alexluck-sift merged commit a345fcb into main Aug 27, 2025
10 checks passed
@alexluck-sift alexluck-sift deleted the python/mkdocs-init branch August 27, 2025 22:49
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.

2 participants