Prep for new website: move existing docs and disable current publicat…

…ion. (iree-org#5733) Progress on iree-org#5460 * Move the existing `docs/` folder to `docs/developers/`. The new website will go next to that at `docs/website/`. * Remove old doc generation and publication scripts. * Doc publication has been [failing for two weeks](https://github.com/google/iree/actions/workflows/publish_docs.yml) anyways, not worth fixing. * New generation/publication will use different scripts/commands. I have that working on my [`mkdocs-publish`](https://github.com/ScottTodd/iree/tree/mkdocs-publish) branch now. Landing this on `main` first will make the rollout easier. The existing GitHub Pages website will stay up until we push changes to the [`gh-pages`](https://github.com/google/iree/tree/gh-pages) branch. I'm planning on first merging the [`staging-docs-rework`](https://github.com/google/iree/tree/staging-docs-rework) branch _then_ turning on new publishing automation that will push there. The rollback plan (hopefully not needed) is to 1. Disable any newly enabled publishing automation 2. Restore the `gh-pages` branch manually 3. Revert this PR / restore old publishing scripts/workflows
silvasean · May 5, 2021 · 338756a · 338756a
2 parents 11c0733 + 2bccccf
commit 338756a
Show file tree

Hide file tree

Showing 56 changed files with 26 additions and 620 deletions.
diff --git a/.github/workflows/publish_docs.yml b/.github/workflows/publish_docs.yml
diff --git a/.gitignore b/.gitignore
@@ -54,3 +54,7 @@ gradlew
 gradlew.bat
 gradle/
 local.properties
+
+# Generated documentation files
+mkdocs/site/
+docs/website/site/
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -58,7 +58,7 @@ for them (e.g. because they don't have write access).
 ## Peculiarities
 
 Our documentation on
-[repository management](https://github.com/google/iree/blob/main/docs/developing_iree/repository_management.md)
+[repository management](https://github.com/google/iree/blob/main/docs/developers/developing_iree/repository_management.md)
 has more information on some of the oddities in our repository setup and
 workflows. For the most part, these should be transparent to normal developer
 workflows.

diff --git a/README.md b/README.md
@@ -79,7 +79,7 @@ hardware/API-specific binaries like SPIR-V.
 
 The architecture of IREE is best illustrated by the following picture:
 
-![IREE Architecture](./docs/iree_architecture.svg)
+![IREE Architecture](./docs/developers/iree_architecture.svg)
 
 Being compilation-based means IREE does not have a traditional runtime that
 dispatches "ops" to their fat kernel implementations. What IREE provides is a
@@ -111,12 +111,12 @@ IREE aims to
 ## Roadmap and Milestones
 
 IREE is in the early stages of development and not yet ready for broad adoption.
-Check out the [long-term design roadmap](./docs/design_roadmap.md) to get
-a sense of where we're headed.
+Check out the [long-term design roadmap](./docs/developers/design_roadmap.md) to
+get a sense of where we're headed.
 
 We plan on a quarterly basis using [OKRs](https://en.wikipedia.org/wiki/OKR).
-Review our latest [objectives](./docs/objectives.md) to get a sense of what
-we're up to in the near term.
+Review our latest [objectives](./docs/developers/objectives.md) to get a sense
+of what we're up to in the near term.
 
 We use [GitHub Projects](https://github.com/google/iree/projects) to track
 progress on IREE components and specific efforts. We use

diff --git a/build_tools/cmake/build_docs.sh b/build_tools/cmake/build_docs.sh
diff --git a/docs/developers/README.md b/docs/developers/README.md
@@ -0,0 +1,4 @@
+# IREE Developer Documentation
+
+Project documentation, developer guides, and other pages not published on
+IREE's user-facing website.
diff --git a/docs/debugging/releases.md → docs/developers/debugging/releases.md b/docs/debugging/releases.md → docs/developers/debugging/releases.md
diff --git a/docs/design_docs/codegen_passes.md → .../developers/design_docs/codegen_passes.md b/docs/design_docs/codegen_passes.md → .../developers/design_docs/codegen_passes.md
diff --git a/docs/design_docs/cuda_backend.md → docs/developers/design_docs/cuda_backend.md b/docs/design_docs/cuda_backend.md → docs/developers/design_docs/cuda_backend.md
diff --git a/docs/design_docs/dynamic_shapes.md → .../developers/design_docs/dynamic_shapes.md b/docs/design_docs/dynamic_shapes.md → .../developers/design_docs/dynamic_shapes.md
diff --git a/docs/design_docs/function_abi.md → docs/developers/design_docs/function_abi.md b/docs/design_docs/function_abi.md → docs/developers/design_docs/function_abi.md
diff --git a/docs/design_docs/hal_driver_features.md → ...lopers/design_docs/hal_driver_features.md b/docs/design_docs/hal_driver_features.md → ...lopers/design_docs/hal_driver_features.md
diff --git a/docs/design_docs/hlo_to_linalg.png → .../developers/design_docs/hlo_to_linalg.png b/docs/design_docs/hlo_to_linalg.png → .../developers/design_docs/hlo_to_linalg.png
diff --git a/docs/design_docs/linalg_to_spirv.png → ...evelopers/design_docs/linalg_to_spirv.png b/docs/design_docs/linalg_to_spirv.png → ...evelopers/design_docs/linalg_to_spirv.png
diff --git a/docs/design_docs/simple_ir_walkthrough.md → ...pers/design_docs/simple_ir_walkthrough.md b/docs/design_docs/simple_ir_walkthrough.md → ...pers/design_docs/simple_ir_walkthrough.md
diff --git a/docs/design_roadmap.md → docs/developers/design_roadmap.md b/docs/design_roadmap.md → docs/developers/design_roadmap.md
diff --git a/docs/developing_iree/benchmarking.md → ...evelopers/developing_iree/benchmarking.md b/docs/developing_iree/benchmarking.md → ...evelopers/developing_iree/benchmarking.md
diff --git a/docs/developing_iree/ccache.md → docs/developers/developing_iree/ccache.md b/docs/developing_iree/ccache.md → docs/developers/developing_iree/ccache.md
diff --git a/docs/developing_iree/contributor_tips.md → ...opers/developing_iree/contributor_tips.md b/docs/developing_iree/contributor_tips.md → ...opers/developing_iree/contributor_tips.md
diff --git a/docs/developing_iree/developer_overview.md → ...ers/developing_iree/developer_overview.md b/docs/developing_iree/developer_overview.md → ...ers/developing_iree/developer_overview.md
diff --git a/docs/developing_iree/e2e_benchmarking.md → ...opers/developing_iree/e2e_benchmarking.md b/docs/developing_iree/e2e_benchmarking.md → ...opers/developing_iree/e2e_benchmarking.md
diff --git a/docs/developing_iree/profiling.md → docs/developers/developing_iree/profiling.md b/docs/developing_iree/profiling.md → docs/developers/developing_iree/profiling.md
diff --git a/docs/developing_iree/profiling_cpu_events.md → ...s/developing_iree/profiling_cpu_events.md b/docs/developing_iree/profiling_cpu_events.md → ...s/developing_iree/profiling_cpu_events.md
diff --git a/docs/developing_iree/profiling_vulkan_gpu.md → ...s/developing_iree/profiling_vulkan_gpu.md b/docs/developing_iree/profiling_vulkan_gpu.md → ...s/developing_iree/profiling_vulkan_gpu.md
diff --git a/docs/developing_iree/profiling_with_tracy.md → ...s/developing_iree/profiling_with_tracy.md b/docs/developing_iree/profiling_with_tracy.md → ...s/developing_iree/profiling_with_tracy.md
diff --git a/.../developing_iree/repository_management.md → .../developing_iree/repository_management.md b/.../developing_iree/repository_management.md → .../developing_iree/repository_management.md
diff --git a/docs/developing_iree/sanitizers.md → .../developers/developing_iree/sanitizers.md b/docs/developing_iree/sanitizers.md → .../developers/developing_iree/sanitizers.md
diff --git a/docs/developing_iree/testing_guide.md → ...velopers/developing_iree/testing_guide.md b/docs/developing_iree/testing_guide.md → ...velopers/developing_iree/testing_guide.md
diff --git a/...et_started/cmake_options_and_variables.md → ...et_started/cmake_options_and_variables.md b/...et_started/cmake_options_and_variables.md → ...et_started/cmake_options_and_variables.md
diff --git a/docs/get_started/generic_vulkan_env_setup.md → ...s/get_started/generic_vulkan_env_setup.md b/docs/get_started/generic_vulkan_env_setup.md → ...s/get_started/generic_vulkan_env_setup.md
diff --git a/..._started/getting_started_android_cmake.md → ..._started/getting_started_android_cmake.md b/..._started/getting_started_android_cmake.md → ..._started/getting_started_android_cmake.md
diff --git a/...et_started/getting_started_linux_bazel.md → ...et_started/getting_started_linux_bazel.md b/...et_started/getting_started_linux_bazel.md → ...et_started/getting_started_linux_bazel.md
diff --git a/...et_started/getting_started_linux_cmake.md → ...et_started/getting_started_linux_cmake.md b/...et_started/getting_started_linux_cmake.md → ...et_started/getting_started_linux_cmake.md
diff --git a/...t_started/getting_started_linux_vulkan.md → ...t_started/getting_started_linux_vulkan.md b/...t_started/getting_started_linux_vulkan.md → ...t_started/getting_started_linux_vulkan.md
diff --git a/...et_started/getting_started_macos_bazel.md → ...et_started/getting_started_macos_bazel.md b/...et_started/getting_started_macos_bazel.md → ...et_started/getting_started_macos_bazel.md
diff --git a/...et_started/getting_started_macos_cmake.md → ...et_started/getting_started_macos_cmake.md b/...et_started/getting_started_macos_cmake.md → ...et_started/getting_started_macos_cmake.md
diff --git a/docs/get_started/getting_started_python.md → ...ers/get_started/getting_started_python.md b/docs/get_started/getting_started_python.md → ...ers/get_started/getting_started_python.md
diff --git a/...et_started/getting_started_riscv_cmake.md → ...et_started/getting_started_riscv_cmake.md b/...et_started/getting_started_riscv_cmake.md → ...et_started/getting_started_riscv_cmake.md
diff --git a/...get_started/getting_started_tensorflow.md → ...get_started/getting_started_tensorflow.md b/...get_started/getting_started_tensorflow.md → ...get_started/getting_started_tensorflow.md
diff --git a/..._started/getting_started_windows_bazel.md → ..._started/getting_started_windows_bazel.md b/..._started/getting_started_windows_bazel.md → ..._started/getting_started_windows_bazel.md
diff --git a/..._started/getting_started_windows_cmake.md → ..._started/getting_started_windows_cmake.md b/..._started/getting_started_windows_cmake.md → ..._started/getting_started_windows_cmake.md
diff --git a/...started/getting_started_windows_vulkan.md → ...started/getting_started_windows_vulkan.md b/...started/getting_started_windows_vulkan.md → ...started/getting_started_windows_vulkan.md
diff --git a/docs/iree_architecture.svg → docs/developers/iree_architecture.svg b/docs/iree_architecture.svg → docs/developers/iree_architecture.svg
diff --git a/docs/iree_community.md → docs/developers/iree_community.md b/docs/iree_community.md → docs/developers/iree_community.md
diff --git a/docs/objectives.md → docs/developers/objectives.md b/docs/objectives.md → docs/developers/objectives.md
diff --git a/..._coverage/language_and_speech_coverage.md → ..._coverage/language_and_speech_coverage.md b/..._coverage/language_and_speech_coverage.md → ..._coverage/language_and_speech_coverage.md
diff --git a/docs/tensorflow_coverage/tf_base_coverage.md → ...s/tensorflow_coverage/tf_base_coverage.md b/docs/tensorflow_coverage/tf_base_coverage.md → ...s/tensorflow_coverage/tf_base_coverage.md
diff --git a/.../tensorflow_coverage/tf_keras_coverage.md → .../tensorflow_coverage/tf_keras_coverage.md b/.../tensorflow_coverage/tf_keras_coverage.md → .../tensorflow_coverage/tf_keras_coverage.md
diff --git a/docs/tensorflow_coverage/vision_coverage.md → ...rs/tensorflow_coverage/vision_coverage.md b/docs/tensorflow_coverage/vision_coverage.md → ...rs/tensorflow_coverage/vision_coverage.md
diff --git a/iree/base/signature_parser.h b/iree/base/signature_parser.h
@@ -298,8 +298,8 @@ class RawSignatureParser {
 // Parser for signatures generated by SipSignatureMangler.
 // This uses a Visitor interface to walk either input or result structs.
 //
-// Mangler for the 'sip' ABI. See docs/design_docs/function_abi.md in the
-// documentation.
+// Mangler for the 'sip' ABI. See docs/developers/design_docs/function_abi.md in
+// the documentation.
 class SipSignatureParser {
  public:
   enum class StructType {

diff --git a/iree/compiler/Bindings/SIP/Utils/SignatureBuilder.h b/iree/compiler/Bindings/SIP/Utils/SignatureBuilder.h
@@ -81,7 +81,7 @@ class SignatureBuilder {
 // -----------------------------------------------------------------------------
 
 // Mangles raw function signatures.
-// See docs/design_docs/function_abi.md.
+// See docs/developers/design_docs/function_abi.md.
 class RawSignatureMangler {
  public:
   static SignatureBuilder ToFunctionSignature(const SignatureBuilder& inputs,
@@ -122,8 +122,8 @@ class RawSignatureMangler {
 // Mangles function signatures according to the Sip (Structured Index Path) V1
 // scheme.
 //
-// Mangler for the 'sip' ABI. See docs/design_docs/function_abi.md in the
-// documentation.
+// Mangler for the 'sip' ABI. See docs/developers/design_docs/function_abi.md
+// in the documentation.
 class SipSignatureMangler {
  public:
   enum class IndexMode {

diff --git a/iree/compiler/Bindings/SIP/Utils/SignatureParser.h b/iree/compiler/Bindings/SIP/Utils/SignatureParser.h
@@ -253,8 +253,8 @@ class RawSignatureParser {
 // Parser for signatures generated by SipSignatureMangler.
 // This uses a Visitor interface to walk either input or result structs.
 //
-// Mangler for the 'sip' ABI. See docs/design_docs/function_abi.md in the
-// documentation.
+// Mangler for the 'sip' ABI. See docs/developers/design_docs/function_abi.md
+// in the documentation.
 class SipSignatureParser {
  public:
   enum class StructType {

diff --git a/iree/schemas/bytecode_module_def.fbs b/iree/schemas/bytecode_module_def.fbs
@@ -50,7 +50,7 @@ table FunctionSignatureDef {
   // Function level reflection attributes.
   // These are typically used to communicate additional ABI metadata needed
   // for dynamic invocation and host language mapping.
-  // See: docs/design_docs/function_abi.md
+  // See: docs/developers/design_docs/function_abi.md
   reflection_attrs:[ReflectionAttrDef];
 }
 

diff --git a/iree/vm/module.h b/iree/vm/module.h
@@ -334,7 +334,7 @@ typedef struct iree_vm_module {
   // attributes.
   // Returns IREE_STATUS_NOT_FOUND if index >= the number of attributes for
   // the function.
-  // See: docs/design_docs/function_abi.md
+  // See: docs/developers/design_docs/function_abi.md
   iree_status_t(IREE_API_PTR* get_function_reflection_attr)(
       void* self, iree_vm_function_linkage_t linkage, iree_host_size_t ordinal,
       iree_host_size_t index, iree_string_view_t* key,
@@ -394,7 +394,8 @@ iree_vm_function_signature(const iree_vm_function_t* function);
 // Returns the empty string if the reflection data in general or the specific
 // key is not found.
 //
-// See: docs/design_docs/function_abi.md for documentation on the ABI.
+// See: docs/developers/design_docs/function_abi.md for documentation on the
+// ABI.
 IREE_API_EXPORT iree_string_view_t iree_vm_function_reflection_attr(
     const iree_vm_function_t* function, iree_string_view_t key);
 
@@ -405,7 +406,7 @@ IREE_API_EXPORT iree_string_view_t iree_vm_function_reflection_attr(
 // attributes.
 // Returns IREE_STATUS_NOT_FOUND if index >= the number of attributes for
 // the function.
-// See: docs/design_docs/function_abi.md
+// See: docs/developers/design_docs/function_abi.md
 IREE_API_EXPORT iree_status_t iree_vm_get_function_reflection_attr(
     iree_vm_function_t function, iree_host_size_t index,
     iree_string_view_t* key, iree_string_view_t* value);