Browse Source

initial commit

Médéric Hurier 4 months ago
commit
e8c0d9cc36

+ 3
- 0
cookiecutter.json View File

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

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

@@ -0,0 +1,12 @@
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}}/build/'
8
+
9
+commit-{{cookiecutter.name}}: doc;
10
+
11
+doc: .venv
12
+	.venv/bin/sphinx-build -c '{{cookiecutter.name}}/' '{{cookiecutter.name}}/source/' '{{cookiecutter.name}}/build/'

+ 9
- 0
{{cookiecutter.name}}/conf.py View File

@@ -0,0 +1,9 @@
1
+# -- Project information
2
+
3
+project = "Project Documentation"
4
+
5
+# -- General configuration
6
+
7
+master_doc = "index"
8
+
9
+extensions = []

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

@@ -0,0 +1 @@
1
+sphinx

+ 15
- 0
{{cookiecutter.name}}/source/index.rst View File

@@ -0,0 +1,15 @@
1
+Welcome to the Project documentation
2
+====================================
3
+
4
+.. toctree::
5
+   :maxdepth: 2
6
+   :caption: Contents:
7
+
8
+
9
+
10
+Indices and tables
11
+==================
12
+
13
+* :ref:`genindex`
14
+* :ref:`modindex`
15
+* :ref:`search`