moved the original doc directory to docs/doc

RefactoringTools · Oct 29, 2023 · b925653 · b925653
1 parent e8b0159
commit b925653
Show file tree

Hide file tree

Showing 13 changed files with 18 additions and 0 deletions.
diff --git a/doc/.gitignore → docs/doc/.gitignore b/doc/.gitignore → docs/doc/.gitignore
diff --git a/doc/Erlide.png → docs/doc/Erlide.png b/doc/Erlide.png → docs/doc/Erlide.png
diff --git a/docs/doc/README.txt b/docs/doc/README.txt
@@ -0,0 +1,18 @@
+
+=== How to generate Edoc files ====
+
+Runs EDoc on a given set of source files:
+  files(Files, Options) -> ok
+
+Eshell V10.7  (abort with ^G)
+1> pwd().
+.../wrangler/src
+ok
+2> Files = ["api_refac.erl", "api_wrangler.erl"].
+["api_refac.erl","api_wrangler.erl"]
+3> edoc:files(Files, [{dir, "../docs/doc"}]). %% the 'dir' option specifies the output directory for the generated files.
+ok
+
+
+For more usage of Edoc, please check:
+https://www.erlang.org/doc/apps/edoc
diff --git a/doc/Wrangler1.JPG → docs/doc/Wrangler1.JPG b/doc/Wrangler1.JPG → docs/doc/Wrangler1.JPG
diff --git a/doc/Wrangler2.JPG → docs/doc/Wrangler2.JPG b/doc/Wrangler2.JPG → docs/doc/Wrangler2.JPG
diff --git a/doc/behaviour_extraction/modulegraph.png → .../doc/behaviour_extraction/modulegraph.png b/doc/behaviour_extraction/modulegraph.png → .../doc/behaviour_extraction/modulegraph.png
diff --git a/doc/behaviour_extraction/overview.edoc → docs/doc/behaviour_extraction/overview.edoc b/doc/behaviour_extraction/overview.edoc → docs/doc/behaviour_extraction/overview.edoc
diff --git a/doc/customize.JPG → docs/doc/customize.JPG b/doc/customize.JPG → docs/doc/customize.JPG
diff --git a/doc/how_to_use.htm → docs/doc/how_to_use.htm b/doc/how_to_use.htm → docs/doc/how_to_use.htm
diff --git a/doc/overview.edoc → docs/doc/overview.edoc b/doc/overview.edoc → docs/doc/overview.edoc
diff --git a/doc/symbolic_evaluation/core/overview.edoc → ...oc/symbolic_evaluation/core/overview.edoc b/doc/symbolic_evaluation/core/overview.edoc → ...oc/symbolic_evaluation/core/overview.edoc
diff --git a/...mbolic_evaluation/evaluator/overview.edoc → ...mbolic_evaluation/evaluator/overview.edoc b/...mbolic_evaluation/evaluator/overview.edoc → ...mbolic_evaluation/evaluator/overview.edoc
diff --git a/...lic_evaluation/refactorings/overview.edoc → ...lic_evaluation/refactorings/overview.edoc b/...lic_evaluation/refactorings/overview.edoc → ...lic_evaluation/refactorings/overview.edoc