diff --git a/doc/.gitignore b/docs/doc/.gitignore similarity index 100% rename from doc/.gitignore rename to docs/doc/.gitignore diff --git a/doc/Erlide.png b/docs/doc/Erlide.png similarity index 100% rename from doc/Erlide.png rename to docs/doc/Erlide.png diff --git a/docs/doc/README.txt b/docs/doc/README.txt new file mode 100644 index 00000000..ac9d148f --- /dev/null +++ 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 b/docs/doc/Wrangler1.JPG similarity index 100% rename from doc/Wrangler1.JPG rename to docs/doc/Wrangler1.JPG diff --git a/doc/Wrangler2.JPG b/docs/doc/Wrangler2.JPG similarity index 100% rename from doc/Wrangler2.JPG rename to docs/doc/Wrangler2.JPG diff --git a/doc/behaviour_extraction/modulegraph.png b/docs/doc/behaviour_extraction/modulegraph.png similarity index 100% rename from doc/behaviour_extraction/modulegraph.png rename to docs/doc/behaviour_extraction/modulegraph.png diff --git a/doc/behaviour_extraction/overview.edoc b/docs/doc/behaviour_extraction/overview.edoc similarity index 100% rename from doc/behaviour_extraction/overview.edoc rename to docs/doc/behaviour_extraction/overview.edoc diff --git a/doc/customize.JPG b/docs/doc/customize.JPG similarity index 100% rename from doc/customize.JPG rename to docs/doc/customize.JPG diff --git a/doc/how_to_use.htm b/docs/doc/how_to_use.htm similarity index 100% rename from doc/how_to_use.htm rename to docs/doc/how_to_use.htm diff --git a/doc/overview.edoc b/docs/doc/overview.edoc similarity index 100% rename from doc/overview.edoc rename to docs/doc/overview.edoc diff --git a/doc/symbolic_evaluation/core/overview.edoc b/docs/doc/symbolic_evaluation/core/overview.edoc similarity index 100% rename from doc/symbolic_evaluation/core/overview.edoc rename to docs/doc/symbolic_evaluation/core/overview.edoc diff --git a/doc/symbolic_evaluation/evaluator/overview.edoc b/docs/doc/symbolic_evaluation/evaluator/overview.edoc similarity index 100% rename from doc/symbolic_evaluation/evaluator/overview.edoc rename to docs/doc/symbolic_evaluation/evaluator/overview.edoc diff --git a/doc/symbolic_evaluation/refactorings/overview.edoc b/docs/doc/symbolic_evaluation/refactorings/overview.edoc similarity index 100% rename from doc/symbolic_evaluation/refactorings/overview.edoc rename to docs/doc/symbolic_evaluation/refactorings/overview.edoc