-
Notifications
You must be signed in to change notification settings - Fork 299
build(docs): Adds make docs phony target #3693
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
rchowell
commented
Jan 16, 2025
- installs the mkdocs deps in requirements-docs.txt
- runs mkdocs serve
CodSpeed Performance ReportMerging #3693 will improve performances by 42.51%Comparing Summary
Benchmarks breakdown
|
Makefile
Outdated
@@ -70,6 +70,10 @@ test: .venv build ## Run tests | |||
dsdgen: .venv ## Generate TPC-DS data | |||
$(VENV_BIN)/python benchmarking/tpcds/datagen.py --scale-factor=$(SCALE_FACTOR) --tpcds-gen-folder=$(OUTPUT_DIR) | |||
|
|||
.PHONY: docs | |||
docs: .venv ## Serve docs | |||
uv pip install -r requirements-docs.txt; $(VENV_BIN)/mkdocs serve |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You can run this in a script with UV with a full-self describing requirements like so:
# /// script
# requires-python = ">=3.12"
# dependencies = ["mkdocs-jupyter", ...]
# ///
# your script here
subprocess.call(["mkdocs", "serve"])
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
uv run myscript.py
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@samster25: something like uv run --with mkdocs-jupyter ... mkdocs serve
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #3693 +/- ##
==========================================
+ Coverage 77.79% 77.83% +0.04%
==========================================
Files 729 732 +3
Lines 90477 90563 +86
==========================================
+ Hits 70384 70494 +110
+ Misses 20093 20069 -24 |