From fdccd8f9265be47a0e209006a28e80f361d40d77 Mon Sep 17 00:00:00 2001 From: FranzHeubach Date: Mon, 8 Jul 2019 12:51:33 -0300 Subject: [PATCH] Rename doc directory to docs. --- .gitignore | 4 ++-- {doc => docs}/Makefile | 0 {doc => docs}/_static/layout.html | 0 {doc => docs}/_static/logo.png | Bin {doc => docs}/_templates/project.html | 0 {doc => docs}/api.rst | 0 {doc => docs}/conf.py | 0 {doc => docs}/index.rst | 0 {doc => docs}/information/changes.rst | 0 {doc => docs}/information/contributing.rst | 9 +++++++++ {doc => docs}/installing.rst | 0 {doc => docs}/prerequisites.rst | 0 12 files changed, 11 insertions(+), 2 deletions(-) rename {doc => docs}/Makefile (100%) rename {doc => docs}/_static/layout.html (100%) rename {doc => docs}/_static/logo.png (100%) rename {doc => docs}/_templates/project.html (100%) rename {doc => docs}/api.rst (100%) rename {doc => docs}/conf.py (100%) rename {doc => docs}/index.rst (100%) rename {doc => docs}/information/changes.rst (100%) rename {doc => docs}/information/contributing.rst (92%) rename {doc => docs}/installing.rst (100%) rename {doc => docs}/prerequisites.rst (100%) diff --git a/.gitignore b/.gitignore index 0781c7653..7e661f395 100644 --- 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 b/docs/Makefile similarity index 100% rename from doc/Makefile rename to docs/Makefile diff --git a/doc/_static/layout.html b/docs/_static/layout.html similarity index 100% rename from doc/_static/layout.html rename to docs/_static/layout.html diff --git a/doc/_static/logo.png b/docs/_static/logo.png similarity index 100% rename from doc/_static/logo.png rename to docs/_static/logo.png diff --git a/doc/_templates/project.html b/docs/_templates/project.html similarity index 100% rename from doc/_templates/project.html rename to docs/_templates/project.html diff --git a/doc/api.rst b/docs/api.rst similarity index 100% rename from doc/api.rst rename to docs/api.rst diff --git a/doc/conf.py b/docs/conf.py similarity index 100% rename from doc/conf.py rename to docs/conf.py diff --git a/doc/index.rst b/docs/index.rst similarity index 100% rename from doc/index.rst rename to docs/index.rst diff --git a/doc/information/changes.rst b/docs/information/changes.rst similarity index 100% rename from doc/information/changes.rst rename to docs/information/changes.rst diff --git a/doc/information/contributing.rst b/docs/information/contributing.rst similarity index 92% rename from doc/information/contributing.rst rename to docs/information/contributing.rst index 4563464e8..70d0ebc68 100644 --- a/doc/information/contributing.rst +++ b/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 b/docs/installing.rst similarity index 100% rename from doc/installing.rst rename to docs/installing.rst diff --git a/doc/prerequisites.rst b/docs/prerequisites.rst similarity index 100% rename from doc/prerequisites.rst rename to docs/prerequisites.rst