diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 9612f82155..e6a0bbf8c1 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -28,12 +28,10 @@ jobs: cp -R target/doc docs/libs rm -R .github - name: Copy Rustc Docs - run: | - cd doc-src && cargo run - - name: Build Index Page - uses: docker://pandoc/core - with: - args: "-s -o docs/index.html doc-src/index.md" + run: cargo run + working-directory: doc-src + - name: Copy index page + run: cp doc-src/index.html docs/index.html - name: Commit Doc Generation run: | git add docs diff --git a/doc-src/index.html b/doc-src/index.html new file mode 100644 index 0000000000..9732131585 --- /dev/null +++ b/doc-src/index.html @@ -0,0 +1,11 @@ + + + + + + +

This URL is only used because it is easy to remember.

+

Paralegal's documentation is actually hosted at https://manishearth.github.io/blog/2018/01/10/whats-tokio-and-async-io-all-about/ and you are being redirected there now.

+

Should the redirect fail you can also click the link.

+ + \ No newline at end of file diff --git a/doc-src/index.md b/doc-src/index.md deleted file mode 100644 index 02aabbd1d2..0000000000 --- a/doc-src/index.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Documentation for Paralegal ---- - -This page hosts the compiled rustdocs for -[`Paralegal`](https://github.com/brownsys/dfpp) and its dependencies and also -for the rust compiler version 1.63.0, which is the one that `paralegal_flow` is -linking against. The compiler docs do not interlink with the docs for the -`paralegal_flow` crate and its dependencies, because I haven't yet figured out -how to build them such that they do. As a result the two documentations are -hosted here separately. - -- Generated rustdocs (dependent, non-rustc crates are linked). - - Doc for the [property definition framework](libs/paralegal_policy/index.html) - - Internal doc for the [flow analyzer](libs/paralegal_flow/index.html) -- [Link to the rustc 1.63.0 documentation](compiler/index.html) \ No newline at end of file