Skip to content

docs: build docs using uv#36

Merged
hknutsen merged 7 commits intomainfrom
docs/build-docs-using-uv
Nov 11, 2025
Merged

docs: build docs using uv#36
hknutsen merged 7 commits intomainfrom
docs/build-docs-using-uv

Conversation

@hknutsen
Copy link
Member

@hknutsen hknutsen commented Nov 11, 2025

  • Add section "Building documentation" to README.
  • Move instructions for building and serving the documentation locally from the contributing guidelines to the new section in the README.
  • Move documentation dependecies from docs/requirements.txt to the root pyproject.toml, allowing documentation dependencies to be installed by uv sync.
  • Update instructions to run MkDocs using uv.
  • Add updated uv.lock file generated by running uv sync --all-extras - the lockfile now includes documentation dependencies.
  • Update documentation CI/CD workflow to install documentation dependencies from pyproject.toml.

- Add section "Building documentation" to README.
- Move instructions for building and serving the documentation locally from the contributing guidelines to the new section in the README.
- Move documentation dependecies from `docs/requirements.txt` to the root `pyproject.toml`, allowing documentation dependencies to be installed by `uv sync`.
- Update instructions to run MkDocs using uv.
- Add updated `uv.lock` file generated by running `uv sync --extras` - the lockfile now includes documentation dependencies.
Will be replaced by a release tag once a release has been created for this commit.
@hknutsen hknutsen marked this pull request as ready for review November 11, 2025 12:32
@hknutsen hknutsen merged commit 15a1125 into main Nov 11, 2025
6 checks passed
@hknutsen hknutsen deleted the docs/build-docs-using-uv branch November 11, 2025 12:38
TordAreStromsnes pushed a commit that referenced this pull request Feb 5, 2026
🤖 I have created a release *beep* *boop*
---


##
[0.2.0](dataorc-v0.1.1...dataorc-v0.2.0)
(2026-02-05)


### Features

* add Azure Key Vault support and documentation
([#42](#42))
([abc42a0](abc42a0))
* create config tool for pipeline setup
([#22](#22))
([21a8a84](21a8a84))
* introduce dictionary functionality for environment variables access
([#57](#57))
([b6291fa](b6291fa))
* mount data lake ([#31](#31))
([0bb3e51](0bb3e51))
* **utils:** add argument parsing helper for Databricks wheel tasks
([#43](#43))
([393c6a2](393c6a2))
* **utils:** add retry logic and customizable parameters for
get_keyvault_secret
([#63](#63))
([acbc2b7](acbc2b7))
* **utils:** implement LakeFileSystem for data lake operations and add
documentation ([#64](#64))
([be9e738](be9e738))
* **utils:** support optional revision suffix in version format and
update tests ([#59](#59))
([8ea0b60](8ea0b60))
* **utils:** treat env as plain string and default to "dev"
([#50](#50))
([65473a8](65473a8))


### Documentation

* add changelog tab
([#20](#20))
([2ec4271](2ec4271))
* add CI status badge
([#9](#9))
([8de41fe](8de41fe))
* add contributing guidelines
([#15](#15))
([434cf31](434cf31))
* add developing instructions
([#33](#33))
([835a35e](835a35e))
* add early development phase warning
([#39](#39))
([406746d](406746d))
* bootstrap package ([#6](#6))
([afbb765](afbb765))
* build docs using uv
([#36](#36))
([15a1125](15a1125))
* initialize documentation structure
([#8](#8))
([0adb45d](0adb45d))

---
This PR was generated with [Release
Please](https://github.com/googleapis/release-please). See
[documentation](https://github.com/googleapis/release-please#release-please).

Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
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