Skip to content

Conversation

rchowell
Copy link
Contributor

make docs
  • installs the mkdocs deps in requirements-docs.txt
  • runs mkdocs serve

@github-actions github-actions bot added the build label Jan 16, 2025
@rchowell rchowell requested review from raunakab and jaychia January 16, 2025 01:37
Copy link

codspeed-hq bot commented Jan 16, 2025

CodSpeed Performance Report

Merging #3693 will improve performances by 42.51%

Comparing rchowell/docs-contributing (11f1f60) with main (f97902a)

Summary

⚡ 2 improvements
✅ 25 untouched benchmarks

Benchmarks breakdown

Benchmark main rchowell/docs-contributing Change
test_count[1 Small File] 3.7 ms 3.3 ms +11.93%
test_iter_rows_first_row[100 Small Files] 214.8 ms 150.7 ms +42.51%

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
Copy link
Contributor

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"])

Copy link
Contributor

Choose a reason for hiding this comment

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

uv run myscript.py

Copy link
Contributor

@jaychia jaychia Jan 16, 2025

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

Copy link

codecov bot commented Jan 16, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 77.83%. Comparing base (34d2036) to head (11f1f60).
Report is 6 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@            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     

see 15 files with indirect coverage changes

@rchowell rchowell merged commit d053e03 into main Jan 16, 2025
43 checks passed
@rchowell rchowell deleted the rchowell/docs-contributing branch January 16, 2025 20:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants