doc: 添加在github上编辑的按钮,以及扩展footer (#940)

Signed-off-by: longjin <longjin@DragonOS.org>
This commit is contained in:
LoGin
2024-09-25 23:53:23 +08:00
committed by GitHub
parent 09dacded09
commit 920bda5958
3 changed files with 37 additions and 2 deletions

View File

@ -8,6 +8,20 @@ SPHINXBUILD ?= sphinx-build
SOURCEDIR = .
BUILDDIR = _build
LANGUAGE = zh_CN
SPHINXOPTS += -D language=$(LANGUAGE)
export CURRENT_GIT_COMMIT_HASH := $(shell git rev-parse --short HEAD)
GIT_STATUS := $(shell git status --porcelain --untracked-files=no)
ifeq ($(strip $(GIT_STATUS)),)
export CURRENT_GIT_COMMIT_DIRTY = 0
else
export CURRENT_GIT_COMMIT_DIRTY = 1
endif
# Put it first so that "make" without argument is like "make help".
help:
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
@ -21,4 +35,4 @@ help:
.PHONY:
html-multiversion:
rm -rf ./$(BUILDDIR) && sphinx-multiversion "$(SOURCEDIR)" ./$(BUILDDIR)/html && cp -rf ./$(BUILDDIR)/html/master/* ./$(BUILDDIR)/html/
rm -rf ./$(BUILDDIR) && CURRENT_GIT_COMMIT_DIRTY=0 sphinx-multiversion $(SPHINXOPTS) "$(SOURCEDIR)" ./$(BUILDDIR)/html && cp -rf ./$(BUILDDIR)/html/master/* ./$(BUILDDIR)/html/