Browse Source

initial commit

Médéric Hurier 4 months ago
commit
1a35b1b3bf

+ 3
- 0
cookiecutter.json View File

@@ -0,0 +1,3 @@
1
+{
2
+    "name": "docs"
3
+}

+ 15
- 0
{{cookiecutter.name}}/Makefile View File

@@ -0,0 +1,15 @@
1
+.PHONY: doc
2
+
3
+init-{{cookiecutter.name}}: .venv
4
+	.venv/bin/pip install '.[{{cookiecutter.name}}]'
5
+
6
+clean-{{cookiecutter.name}}:
7
+	rm -rf '{{cookiecutter.name}}/site'
8
+
9
+commit-{{cookiecutter.name}}: doc;
10
+
11
+doc: .venv
12
+	.venv/bin/mkdocs build --config-file '{{cookiecutter.name}}/mkdocs.yml'
13
+
14
+serve-doc:
15
+	.venv/bin/mkdocs serve --config-file '{{cookiecutter.name}}/mkdocs.yml'

+ 1
- 0
{{cookiecutter.name}}/docs/index.md View File

@@ -0,0 +1 @@
1
+# Documentation Index

+ 1
- 0
{{cookiecutter.name}}/mkdocs.yml View File

@@ -0,0 +1 @@
1
+site_name: Project Documentation

+ 1
- 0
{{cookiecutter.name}}/requirements.txt View File

@@ -0,0 +1 @@
1
+mkdocs