Rename doc directory to docs.

S-Vaes · Jul 8, 2019 · fdccd8f · fdccd8f
1 parent d0248a2
commit fdccd8f
Show file tree

Hide file tree

Showing 12 changed files with 11 additions and 2 deletions.
diff --git a/.gitignore b/.gitignore
@@ -28,8 +28,8 @@ hardware/victims/firmware/simpleserial-*/simpleserial-*-CW*
 hardware/victims/firmware/basic-passwdcheck/basic-passwdcheck-CW*
 *.csv
 *py.bak
-doc/_build
-doc/make.bat
+docs/_build
+docs/make.bat
 
 # Explicit listing of the build artifacts so that they are not included in
 # commits

diff --git a/doc/Makefile → docs/Makefile b/doc/Makefile → docs/Makefile
diff --git a/doc/_static/layout.html → docs/_static/layout.html b/doc/_static/layout.html → docs/_static/layout.html
diff --git a/doc/_static/logo.png → docs/_static/logo.png b/doc/_static/logo.png → docs/_static/logo.png
diff --git a/doc/_templates/project.html → docs/_templates/project.html b/doc/_templates/project.html → docs/_templates/project.html
diff --git a/doc/api.rst → docs/api.rst b/doc/api.rst → docs/api.rst
diff --git a/doc/conf.py → docs/conf.py b/doc/conf.py → docs/conf.py
diff --git a/doc/index.rst → docs/index.rst b/doc/index.rst → docs/index.rst
diff --git a/doc/information/changes.rst → docs/information/changes.rst b/doc/information/changes.rst → docs/information/changes.rst
diff --git a/doc/information/contributing.rst → docs/information/contributing.rst b/doc/information/contributing.rst → docs/information/contributing.rst
@@ -67,6 +67,15 @@ here are some rough guidelines to follow:
  * When adding section links, try to make them intuitive with the toctree
    structure.
 
+ * Use this header structure for documentation:
+     - # with overline, for parts
+     - * with overline, for chapters
+     - =, for sections
+     - -, for subsections
+     - ^, for subsubsections
+     - “, for paragraphs
+
+
 .. _google style guide: https://www.sphinx-doc.org/en/1.5/ext/example_google.html
 
 

diff --git a/doc/installing.rst → docs/installing.rst b/doc/installing.rst → docs/installing.rst
diff --git a/doc/prerequisites.rst → docs/prerequisites.rst b/doc/prerequisites.rst → docs/prerequisites.rst