Skip to content

chore(make): Add make docs and make docs-preview #1150

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Feb 23, 2024
Merged

chore(make): Add make docs and make docs-preview #1150

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f4dff5e
chore(make): Add `make docs` and `make docs-preview`
gadenbuie Feb 22, 2024
6256b8f
chore(make): all docs targets are phone
gadenbuie Feb 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.PHONY: help clean% check% format% lint test pyright playwright% install% testrail% coverage release
.PHONY: help clean% check% format% docs% lint test pyright playwright% install% testrail% coverage release
.DEFAULT_GOAL := help

define BROWSER_PYSCRIPT
Expand Down Expand Up @@ -92,6 +92,14 @@ format-isort:
@echo "-------- Sorting imports with isort --------"
isort .

docs: ## docs: build docs with quartodoc
@echo "-------- Building docs with quartodoc --------"
@cd docs && make quartodoc

docs-preview: ## docs: preview docs in browser
@echo "-------- Previewing docs in browser --------"
@cd docs && make serve

# Default `SUB_FILE` to empty
SUB_FILE:=

Expand Down