Skip to content

Adds base path for GitHub Pages publishing. #48

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 1 commit into from
Jun 9, 2025
Merged

Adds base path for GitHub Pages publishing. #48

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,4 @@ vmlinux

# API docs for local preview only.
_site/
_serve/
10 changes: 7 additions & 3 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,16 +129,19 @@ check-licenses:

.PHONY: serve-docs
serve-docs:
@echo 'to browse: open http://127.0.0.1:8000/documentation/'
@python3 -m http.server --bind 127.0.0.1 --directory ./_site
@echo 'to browse: open http://127.0.0.1:8000/containerization/documentation/'
@rm -rf _serve
@mkdir -p _serve
@cp -a _site _serve/containerization
@python3 -m http.server --bind 127.0.0.1 --directory ./_serve

.PHONY: docs
docs: _site

_site:
@echo Updating API documentation...
rm -rf $@
@scripts/make-docs.sh $@
@scripts/make-docs.sh $@ containerization

.PHONY: cleancontent
cleancontent:
Expand All @@ -150,5 +153,6 @@ clean:
@echo Cleaning the build files...
@rm -rf bin/
@rm -rf _site/
@rm -rf _serve/
@$(SWIFT) package clean
@"$(MAKE)" -C vminitd clean