Relocate documents in docs (#5683)

* Relocate documents in docs

Relocate documents in docs into docs/nnfw to
- Avoid conflict when repo merging
- Avoid confusion when document merging after repo merging

Signed-off-by: Hyeongseok Oh <hseok82.oh@samsung.com>
* Fix Readme and move doxygen config into infra

* Fix link to 2018_high_level_design.md

diff --git a/README.md b/README.md
index 47de639..b041221 100644 (file)
--- a/README.md
+++ b/README.md
@@ -10,14 +10,14 @@ the target platform, such as the Linux kernel based OS including Tizen.
 
 ## Project Documents
 
-- [Roadmap](docs/roadmap.md)
-- [SW Requirement Specification](docs/project/2019_requirement_specification.md)
-- [SW High Level Design](docs/project/2018_high_level_design.md)
+- [Roadmap](docs/nnfw/roadmap.md)
+- [SW Requirement Specification](docs/nnfw/project/2019_requirement_specification.md)
+- [SW High Level Design](docs/nnfw/project/2018_high_level_design.md)
 
 ## Getting started
 
-- For the contribution, please refer to our [contribution guide](docs/HowToContribute.md).
-- You can also find how-to documents [HERE](docs/howto.md).
+- For the contribution, please refer to our [contribution guide](docs/nnfw/HowToContribute.md).
+- You can also find how-to documents [HERE](docs/nnfw/howto.md).
 
 ## Maintainers
 
@@ -36,7 +36,7 @@ You can suggest development of nnfw's features that are not yet available.
 
 The functions requested so far can be checked in the [popular feature request](https://github.sec.samsung.net/STAR/nnfw/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+label%3AFEATURE_REQUEST+sort%3Areactions-%2B1-desc) list.
 
-- If the feature you want is on the list, :+1: to the body of the issue. The feature with the most 
+- If the feature you want is on the list, :+1: to the body of the issue. The feature with the most
 :+1: is placed at the top of the list. When adding new features, we will prioritize them with this reference.
 Of course, it is good to add an additional comment which describes your request in detail.
 
@@ -44,8 +44,8 @@ Of course, it is good to add an additional comment which describes your request
 Sooner or later, the maintainer will tag the `FEATURE_REQUEST` label and appear on the list.
 
 We expect one of the most frequent feature requests would be the operator kernel implementation.
-It is good to make a request, but it is better if you contribute by yourself. See the following guide, 
-[How to Implement Operator Kernel](docs/HowToImplementOperatorKernel.md), for help.
+It is good to make a request, but it is better if you contribute by yourself. See the following guide,
+[How to Implement Operator Kernel](docs/nnfw/HowToImplementOperatorKernel.md), for help.
 
 We are looking forward to your participation.
 Thank you in advance!

diff --git a/docs/2018/fig/nnfw_architecture.png b/docs/nnfw/2018/fig/nnfw_architecture.png
similarity index 100%
rename from docs/2018/fig/nnfw_architecture.png
rename to docs/nnfw/2018/fig/nnfw_architecture.png

diff --git a/docs/2018/fig/nnfw_architecture.pptx b/docs/nnfw/2018/fig/nnfw_architecture.pptx
similarity index 100%
rename from docs/2018/fig/nnfw_architecture.pptx
rename to docs/nnfw/2018/fig/nnfw_architecture.pptx

diff --git a/docs/2018/project/2018_requirement_specification.md b/docs/nnfw/2018/project/2018_requirement_specification.md
similarity index 100%
rename from docs/2018/project/2018_requirement_specification.md
rename to docs/nnfw/2018/project/2018_requirement_specification.md

diff --git a/docs/2018/roadmap.md b/docs/nnfw/2018/roadmap.md
similarity index 100%
rename from docs/2018/roadmap.md
rename to docs/nnfw/2018/roadmap.md

diff --git a/docs/2018/workgroups.md b/docs/nnfw/2018/workgroups.md
similarity index 100%
rename from docs/2018/workgroups.md
rename to docs/nnfw/2018/workgroups.md

diff --git a/docs/HowToContribute.md b/docs/nnfw/HowToContribute.md
similarity index 100%
rename from docs/HowToContribute.md
rename to docs/nnfw/HowToContribute.md

diff --git a/docs/HowToImplementOperatorKernel.md b/docs/nnfw/HowToImplementOperatorKernel.md
similarity index 100%
rename from docs/HowToImplementOperatorKernel.md
rename to docs/nnfw/HowToImplementOperatorKernel.md

diff --git a/docs/fig/nnfw_architecture.png b/docs/nnfw/fig/nnfw_architecture.png
similarity index 100%
rename from docs/fig/nnfw_architecture.png
rename to docs/nnfw/fig/nnfw_architecture.png

diff --git a/docs/fig/nnfw_architecture.pptx b/docs/nnfw/fig/nnfw_architecture.pptx
similarity index 100%
rename from docs/fig/nnfw_architecture.pptx
rename to docs/nnfw/fig/nnfw_architecture.pptx

diff --git a/docs/fig/nnfw_behavior.png b/docs/nnfw/fig/nnfw_behavior.png
similarity index 100%
rename from docs/fig/nnfw_behavior.png
rename to docs/nnfw/fig/nnfw_behavior.png

diff --git a/docs/fig/nnfw_behavior.pptx b/docs/nnfw/fig/nnfw_behavior.pptx
similarity index 100%
rename from docs/fig/nnfw_behavior.pptx
rename to docs/nnfw/fig/nnfw_behavior.pptx

diff --git a/docs/howto.md b/docs/nnfw/howto.md
similarity index 100%
rename from docs/howto.md
rename to docs/nnfw/howto.md

diff --git a/docs/howto/BuildTFfromSource.md b/docs/nnfw/howto/BuildTFfromSource.md
similarity index 100%
rename from docs/howto/BuildTFfromSource.md
rename to docs/nnfw/howto/BuildTFfromSource.md

diff --git a/docs/howto/CrossBuildForAarch64.md b/docs/nnfw/howto/CrossBuildForAarch64.md
similarity index 100%
rename from docs/howto/CrossBuildForAarch64.md
rename to docs/nnfw/howto/CrossBuildForAarch64.md

diff --git a/docs/howto/CrossBuildForArm.md b/docs/nnfw/howto/CrossBuildForArm.md
similarity index 100%
rename from docs/howto/CrossBuildForArm.md
rename to docs/nnfw/howto/CrossBuildForArm.md

diff --git a/docs/howto/HowToAddUnittest.md b/docs/nnfw/howto/HowToAddUnittest.md
similarity index 100%
rename from docs/howto/HowToAddUnittest.md
rename to docs/nnfw/howto/HowToAddUnittest.md

diff --git a/docs/howto/HowToTestManualy.md b/docs/nnfw/howto/HowToTestManualy.md
similarity index 100%
rename from docs/howto/HowToTestManualy.md
rename to docs/nnfw/howto/HowToTestManualy.md

diff --git a/docs/howto/HowToUseDockerImage.md b/docs/nnfw/howto/HowToUseDockerImage.md
similarity index 100%
rename from docs/howto/HowToUseDockerImage.md
rename to docs/nnfw/howto/HowToUseDockerImage.md

diff --git a/docs/howto/HowtoMakeSampleAppOnNnfw.md b/docs/nnfw/howto/HowtoMakeSampleAppOnNnfw.md
similarity index 100%
rename from docs/howto/HowtoMakeSampleAppOnNnfw.md
rename to docs/nnfw/howto/HowtoMakeSampleAppOnNnfw.md

diff --git a/docs/howto/device/xu3-dip.png b/docs/nnfw/howto/device/xu3-dip.png
similarity index 100%
rename from docs/howto/device/xu3-dip.png
rename to docs/nnfw/howto/device/xu3-dip.png

diff --git a/docs/howto/device/xu3_ubuntu.md b/docs/nnfw/howto/device/xu3_ubuntu.md
similarity index 100%
rename from docs/howto/device/xu3_ubuntu.md
rename to docs/nnfw/howto/device/xu3_ubuntu.md

diff --git a/docs/howto/device/xu4_tizen.md b/docs/nnfw/howto/device/xu4_tizen.md
similarity index 100%
rename from docs/howto/device/xu4_tizen.md
rename to docs/nnfw/howto/device/xu4_tizen.md

diff --git a/docs/howto/device/xu4_ubuntu.md b/docs/nnfw/howto/device/xu4_ubuntu.md
similarity index 100%
rename from docs/howto/device/xu4_ubuntu.md
rename to docs/nnfw/howto/device/xu4_ubuntu.md

diff --git a/docs/project/2018_high_level_design.md b/docs/nnfw/project/2018_high_level_design.md
similarity index 100%
rename from docs/project/2018_high_level_design.md
rename to docs/nnfw/project/2018_high_level_design.md

diff --git a/docs/project/2019_requirement_specification.md b/docs/nnfw/project/2019_requirement_specification.md
similarity index 100%
rename from docs/project/2019_requirement_specification.md
rename to docs/nnfw/project/2019_requirement_specification.md

diff --git a/docs/roadmap.md b/docs/nnfw/roadmap.md
similarity index 100%
rename from docs/roadmap.md
rename to docs/nnfw/roadmap.md

diff --git a/docs/tests/Convolution_manual_3x3.xlsx b/docs/nnfw/tests/Convolution_manual_3x3.xlsx
similarity index 100%
rename from docs/tests/Convolution_manual_3x3.xlsx
rename to docs/nnfw/tests/Convolution_manual_3x3.xlsx

diff --git a/docs/tests/Softmax_manual.xlsx b/docs/nnfw/tests/Softmax_manual.xlsx
similarity index 100%
rename from docs/tests/Softmax_manual.xlsx
rename to docs/nnfw/tests/Softmax_manual.xlsx

diff --git a/docs/workgroups.md b/docs/nnfw/workgroups.md
similarity index 100%
rename from docs/workgroups.md
rename to docs/nnfw/workgroups.md

diff --git a/infra/nnfw/command/doxygen b/infra/nnfw/command/doxygen
index f0fbb63..f455934 100644 (file)
--- a/infra/nnfw/command/doxygen
+++ b/infra/nnfw/command/doxygen
@@ -2,6 +2,6 @@
 
 pushd ${NNFW_PROJECT_PATH} > /dev/null
 
-doxygen docs/doxygen/Doxyfile
+doxygen infra/nnfw/doxygen/Doxyfile
 
 popd > /dev/null

diff --git a/docs/doxygen/Doxyfile b/infra/nnfw/doxygen/Doxyfile
similarity index 99%
rename from docs/doxygen/Doxyfile
rename to infra/nnfw/doxygen/Doxyfile
index 7cf0243..c04a7bb 100644 (file)
--- a/docs/doxygen/Doxyfile
+++ b/infra/nnfw/doxygen/Doxyfile
@@ -875,7 +875,7 @@ RECURSIVE              = YES
 
 EXCLUDE                = Product/ \
                          report/ \
-                         contrib/ \
+                         runtimes/contrib/ \
                          docs/doxygen/html/ \
                          externals/ \
                          packaging/ \
@@ -992,7 +992,7 @@ FILTER_SOURCE_PATTERNS =
 # (index.html). This can be useful if you have a project on for instance GitHub
 # and want to reuse the introduction page also for the doxygen output.
 
-USE_MDFILE_AS_MAINPAGE = docs/roadmap.md
+USE_MDFILE_AS_MAINPAGE = docs/nnfw/roadmap.md
 
 #---------------------------------------------------------------------------
 # Configuration options related to source browsing