Dev docs (#6)

- Add documentation and examples for ptcmd
- Add entrypoint decorator for CLI entry points

Author: Ovizro

Makefile

@@ -1,43 +1,56 @@
-.PHONY: run install install_all refresh uninstall develop build_dist test coverage coverage_result clean
-
 MODULE := ptcmd
 MODULE_PATH := src/${MODULE}
 PIP_MODULE := ptcmd
 
 all: clean test lint build_dist
 refresh: clean develop test lint
 
+.PHONY: run
 run:
 	python -m ${MODULE}
 
+.PHONY: build_dist
 build_dist:
 	python -m build
 
+.PHONY: install
 install:
 	pip install .
 
+.PHONY: install_all
 install_all:
 	pip install .[all]
 
+.PHONY: develop
 develop:
 	pip install -e .[dev]
 
+.PHONY: lint
 lint:
 	ruff check ${MODULE_PATH} tests/ --fix
 
+.PHONY: docs
+docs:
+	mkdocs build --clean
+
+.PHONY: test
 test:
-	pytest
+	python -m pytest
 
+.PHONY: coverage_result
 coverage_result:
-	coverage run --source ${MODULE_PATH} --parallel-mode -m pytest
+	python -m coverage run --source ${MODULE_PATH} --parallel-mode -m pytest
 
+.PHONY: coverage
 coverage: coverage_result
 	coverage combine
 	coverage html -i
 
+.PHONY: uninstall
 uninstall:
 	pip uninstall ${PIP_MODULE} -y || true
 
+.PHONY: clean
 clean:
 	rm -rf build
 	rm -rf dist

docs/.nav.yml

@@ -0,0 +1,15 @@
+nav:
+  - Overview:
+    - index.md
+    - interactive_cli.md
+    - feature.md
+    - start.md
+  - User Guide:
+    - user_guide/index.md
+    - user_guide/core.md
+    - user_guide/command.md
+    - user_guide/argument.md
+  - Examples: https://github.com/Visecy/ptcmd/tree/master/examples
+  - API Reference:
+    - "api/index.md"
+    - "api/*"

docs/api/argument.md

@@ -0,0 +1,3 @@
+# ptcmd.argument
+
+::: ptcmd.argument

docs/api/command.md

@@ -0,0 +1,3 @@
+# ptcmd.command
+
+::: ptcmd.command

docs/api/completer.md

@@ -0,0 +1,3 @@
+# ptcmd.completer
+
+::: ptcmd.completer

docs/api/core.md

@@ -0,0 +1,3 @@
+# ptcmd.core
+
+::: ptcmd.core

docs/api/index.md

@@ -0,0 +1,7 @@
+# API Reference
+
+- [ptcmd.argument](argument.md)
+- [ptcmd.info](info.md)
+- [ptcmd.command](command.md)
+- [ptcmd.completer](completer.md)
+- [ptcmd.core](core.md)

docs/api/index.zh.md

@@ -0,0 +1,9 @@
+# API 参考
+
+> API文档由代码自动生成，不提供翻译
+
+- [ptcmd.argument](argument.md)
+- [ptcmd.info](info.md)
+- [ptcmd.command](command.md)
+- [ptcmd.completer](completer.md)
+- [ptcmd.core](core.md)

docs/api/info.md

@@ -0,0 +1,3 @@
+# ptcmd.info
+
+::: ptcmd.info