Update Cranelift's documentation after the merger. (bytecodealliance#…

…1238) Update the documentation for the merger, and also for various changes in Cranelift. Remove some old obsolete documentation, and convert the remaining Sphinx files to Markdown. Some of the remaining content is still out of date, but this is a step forward.
kevlarr · Mar 5, 2020 · 3179dcf · 3179dcf
1 parent fc692f6
commit 3179dcf
Show file tree

Hide file tree

Showing 36 changed files with 422 additions and 1,313 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -4,7 +4,7 @@ version = "0.12.0"
 authors = ["The Wasmtime Project Developers"]
 description = "Command-line interface for Wasmtime"
 license = "Apache-2.0 WITH LLVM-exception"
-documentation = "https://cranelift.readthedocs.io/"
+documentation = "https://bytecodealliance.github.io/wasmtime/cli.html"
 categories = ["wasm"]
 keywords = ["webassembly", "wasm"]
 repository = "https://github.com/bytecodealliance/wasmtime"

diff --git a/README.md b/README.md
@@ -65,7 +65,7 @@ Hello, world!
   with your needs. It fits on tiny chips as well as makes use of huge servers.
   Wasmtime can be embedded into almost any application too.
 
-* **Fast**. Wasmtime is built on the optimizing Cranelift code generator to
+* **Fast**. Wasmtime is built on the optimizing [Cranelift] code generator to
   quickly generate high-quality machine code at runtime.
 
 * **Configurable**. Whether you need to precompile your wasm ahead of time,
@@ -82,6 +82,8 @@ Hello, world!
   well. Wasmtime developers are intimately engaged with the WebAssembly
   standards process all along the way too.
 
+[Cranelift]: https://github.com/bytecodealliance/wasmtime/blob/master/cranelift/README.md
+
 ## Documentation
 
 [📚 Read the Wasmtime guide here! 📚][guide]

diff --git a/cranelift/Cargo.toml b/cranelift/Cargo.toml
@@ -4,7 +4,7 @@ authors = ["The Cranelift Project Developers"]
 version = "0.59.0"
 description = "Binaries for testing the Cranelift libraries"
 license = "Apache-2.0 WITH LLVM-exception"
-documentation = "https://cranelift.readthedocs.io/"
+documentation = "https://github.com/bytecodealliance/wasmtime/blob/master/cranelift/docs/index.md"
 repository = "https://github.com/bytecodealliance/cranelift"
 publish = false
 edition = "2018"

diff --git a/cranelift/README.md b/cranelift/README.md
@@ -4,19 +4,16 @@ Cranelift Code Generator
 **A [Bytecode Alliance][BA] project**
 
 Cranelift is a low-level retargetable code generator. It translates a
-[target-independent intermediate
-representation](https://cranelift.readthedocs.io/en/latest/ir.html)
+[target-independent intermediate representation](docs/ir.md)
 into executable machine code.
 
 [BA]: https://bytecodealliance.org/
-[![Documentation Status](https://readthedocs.org/projects/cranelift/badge/?version=latest)](https://cranelift.readthedocs.io/en/latest/?badge=latest)
 [![Build Status](https://github.com/bytecodealliance/cranelift/workflows/CI/badge.svg)](https://github.com/bytecodealliance/cranelift/actions)
 [![Fuzzit Status](https://app.fuzzit.dev/badge?org_id=bytecodealliance)](https://app.fuzzit.dev/orgs/bytecodealliance/dashboard)
 [![Chat](https://img.shields.io/badge/chat-zulip-brightgreen.svg)](https://bytecodealliance.zulipchat.com/#narrow/stream/217117-cranelift/topic/general)
 ![Minimum rustc 1.37](https://img.shields.io/badge/rustc-1.37+-green.svg)
 
-For more information, see [the
-documentation](https://cranelift.readthedocs.io/en/latest/?badge=latest).
+For more information, see [the documentation](docs/index.md).
 
 For an example of how to use the JIT, see the [SimpleJIT Demo], which
 implements a toy language.
@@ -160,21 +157,6 @@ features = ["release_max_level_warn"]
 ```
 </details>
 
-<details>
-<summary>Building the documentation</summary>
-
-Cranelift's documentation is [published online](https://cranelift.readthedocs.io/).
-
-To build the documentation locally, you need the [Sphinx documentation
-generator](http://www.sphinx-doc.org/) as well as Python 3::
-
-    $ pip install sphinx sphinx-autobuild sphinx_rtd_theme
-    $ cd cranelift/docs
-    $ make html
-    $ open _build/html/index.html
-
-</details>
-
 Editor Support
 --------------
 

diff --git a/cranelift/bforest/Cargo.toml b/cranelift/bforest/Cargo.toml
@@ -4,7 +4,7 @@ name = "cranelift-bforest"
 version = "0.59.0"
 description = "A forest of B+-trees"
 license = "Apache-2.0 WITH LLVM-exception"
-documentation = "https://cranelift.readthedocs.io/"
+documentation = "https://docs.rs/cranelift-bforest"
 repository = "https://github.com/bytecodealliance/cranelift"
 categories = ["no-std"]
 readme = "README.md"

diff --git a/cranelift/codegen/Cargo.toml b/cranelift/codegen/Cargo.toml
@@ -4,7 +4,7 @@ name = "cranelift-codegen"
 version = "0.59.0"
 description = "Low-level code generator library"
 license = "Apache-2.0 WITH LLVM-exception"
-documentation = "https://cranelift.readthedocs.io/"
+documentation = "https://docs.rs/cranelift-codegen"
 repository = "https://github.com/bytecodealliance/cranelift"
 categories = ["no-std"]
 readme = "README.md"

diff --git a/cranelift/codegen/src/result.rs b/cranelift/codegen/src/result.rs
@@ -20,7 +20,7 @@ pub enum CodegenError {
     /// Cranelift can compile very large and complicated functions, but the [implementation has
     /// limits][limits] that cause compilation to fail when they are exceeded.
     ///
-    /// [limits]: https://cranelift.readthedocs.io/en/latest/ir.html#implementation-limits
+    /// [limits]: https://github.com/bytecodealliance/wasmtime/blob/master/cranelift/docs/ir.md#implementation-limits
     #[error("Implementation limit exceeded")]
     ImplLimitExceeded,
 

diff --git a/cranelift/docs/Makefile b/cranelift/docs/Makefile
diff --git a/cranelift/docs/callex.clif b/cranelift/docs/callex.clif
diff --git a/cranelift/docs/clif_lexer.py b/cranelift/docs/clif_lexer.py