Move documentation from doc to docs. Remove refman md files and add h…

…tml files for API documentation #Fix check license and one typo
openenclave · Aug 20, 2018 · c041963 · c041963
1 parent 4adacaf
commit c041963
Show file tree

Hide file tree

Showing 308 changed files with 14,571 additions and 3,946 deletions.
diff --git a/.check-license.ignore b/.check-license.ignore
@@ -13,14 +13,16 @@
 ./.clang-format
 ./debugger/pythonExtension/load_symbol_cmd.py
 ./debugger/pythonExtension/readelf.py
-./doc/DesignOverview.docx
-./doc/DesignOverview.pdf
+./docs/DesignOverview.docx
+./docs/DesignOverview.pdf
+./docs/refman/html
 .exrc
 ./.git
 .gitignore
 ./include/openenclave/internal/queue.h
 LICENSE
 *.md
+*.html
 *.json
 ./.openenclaveroot
 *.pem
@@ -61,7 +63,6 @@ LICENSE
 ./tools/oesign/files/log.txt
 VERSION
 ./prereqs/packages/.packages
-./doc/refman/md/*.dump
 ./3rdparty/LICENSES
 ./tests/report/data/tcbInfo.json
 ./tests/report/data/quote.dat

diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -79,7 +79,7 @@ add_subdirectory(tests)
 if (UNIX)
 add_subdirectory(3rdparty)
 add_subdirectory(debugger)
-add_subdirectory(doc/refman)
+add_subdirectory(docs/refman)
 add_subdirectory(enclave)
 add_subdirectory(enclave/core)
 add_subdirectory(idl)

diff --git a/README.md b/README.md
@@ -20,22 +20,22 @@ The current implementation of Open Enclave is built on [Intel Software Guard Ext
 Design Overview
 -------------
 
-The [Design Overview](doc/DesignOverview.pdf) document provides a brief design overview of the Open Enclave SDK. It describes the parts of the SDK and how they work together to create, invoke, and terminate enclaves. 
+The [Design Overview](docs/DesignOverview.pdf) document provides a brief design overview of the Open Enclave SDK. It describes the parts of the SDK and how they work together to create, invoke, and terminate enclaves. 
 
 Getting Started
 ---------------
-To build and experience enclaves with the Open Enclave SDK, start [here](doc/GettingStartedDocs/GettingStarted.md)
+To build and experience enclaves with the Open Enclave SDK, start [here](docs/GettingStartedDocs/GettingStarted.md)
 
 Contributing
 ------------
 
-This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, see [Contributing to Open Enclave](doc/Contributing.md).
+This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, see [Contributing to Open Enclave](docs/Contributing.md).
 
 This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
 For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
 contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
 
-See the [Development Guide](doc/DevelopmentGuide.md) for details about developing code in this repo, such as coding style and development processes.
+See the [Development Guide](docs/DevelopmentGuide.md) for details about developing code in this repo, such as coding style and development processes.
 
 
 Licensing

diff --git a/...lave_8h_a10b3ff4164db3852c41fa431950bebb3_1a10b3ff4164db3852c41fa431950bebb3.md b/...lave_8h_a10b3ff4164db3852c41fa431950bebb3_1a10b3ff4164db3852c41fa431950bebb3.md
diff --git a/...lave_8h_a21d688325fdb8399b588db6652605843_1a21d688325fdb8399b588db6652605843.md b/...lave_8h_a21d688325fdb8399b588db6652605843_1a21d688325fdb8399b588db6652605843.md
diff --git a/...lave_8h_a262d5e0916223b50b32a2599cc881673_1a262d5e0916223b50b32a2599cc881673.md b/...lave_8h_a262d5e0916223b50b32a2599cc881673_1a262d5e0916223b50b32a2599cc881673.md
diff --git a/...lave_8h_a2816745c2f67233b6b95ef69155cc378_1a2816745c2f67233b6b95ef69155cc378.md b/...lave_8h_a2816745c2f67233b6b95ef69155cc378_1a2816745c2f67233b6b95ef69155cc378.md
diff --git a/...lave_8h_a2bbc7ed6f89a7962395753edfd342164_1a2bbc7ed6f89a7962395753edfd342164.md b/...lave_8h_a2bbc7ed6f89a7962395753edfd342164_1a2bbc7ed6f89a7962395753edfd342164.md
diff --git a/...lave_8h_a3ee9827bf9e87ebb63095823f21e48e8_1a3ee9827bf9e87ebb63095823f21e48e8.md b/...lave_8h_a3ee9827bf9e87ebb63095823f21e48e8_1a3ee9827bf9e87ebb63095823f21e48e8.md
diff --git a/...lave_8h_a462afe878b40bf01052d9100b1ed132c_1a462afe878b40bf01052d9100b1ed132c.md b/...lave_8h_a462afe878b40bf01052d9100b1ed132c_1a462afe878b40bf01052d9100b1ed132c.md
diff --git a/...lave_8h_a4a6f218a37d256fdda8e5912f40c9dd9_1a4a6f218a37d256fdda8e5912f40c9dd9.md b/...lave_8h_a4a6f218a37d256fdda8e5912f40c9dd9_1a4a6f218a37d256fdda8e5912f40c9dd9.md