docs: add obikmer user guide and MkDocs build configuration
Introduces a comprehensive documentation set covering theoretical foundations, CLI usage, installation, and system architecture. Adds MkDocs configuration and Makefile targets to generate, serve with live reload, and clean the documentation site. Includes citation styles and bibliography files for academic references.
This commit is contained in:
@@ -10,6 +10,11 @@ DOC_FILE := mkdocs.yml
|
||||
DOC_SITE := doc
|
||||
DOC_PORT := 8001
|
||||
|
||||
DOC_USER_DIR := UserDocMD
|
||||
DOC_USER_FILE := mkdocs-user.yml
|
||||
DOC_USER_SITE := doc-user
|
||||
DOC_USER_PORT := 8002
|
||||
|
||||
# ── virtualenv ────────────────────────────────────────────────────────────────
|
||||
|
||||
$(VENV)/bin/activate:
|
||||
@@ -60,8 +65,22 @@ doc-serve: $(MKDOCS)
|
||||
clean-doc:
|
||||
rm -rf $(DOC_SITE)/
|
||||
|
||||
.PHONY: doc-user
|
||||
doc-user: $(MKDOCS)
|
||||
$(MKDOCS) build -f $(DOC_USER_FILE)
|
||||
|
||||
.PHONY: doc-user-serve
|
||||
doc-user-serve: $(MKDOCS)
|
||||
$(MKDOCS) serve -f $(DOC_USER_FILE) \
|
||||
--dev-addr=127.0.0.1:$(DOC_USER_PORT) \
|
||||
--livereload
|
||||
|
||||
.PHONY: clean-doc-user
|
||||
clean-doc-user:
|
||||
rm -rf $(DOC_USER_SITE)/
|
||||
|
||||
.PHONY: clean
|
||||
clean: clean-doc
|
||||
clean: clean-doc clean-doc-user
|
||||
rm -rf $(VENV)
|
||||
|
||||
# ── release ───────────────────────────────────────────────────────────────────
|
||||
|
||||
Reference in New Issue
Block a user