documentation revamp according to RFC (#160)

Signed-off-by: cosmicBboy <[email protected]>
flyteorg · Apr 30, 2021 · 4b7cd8a · 4b7cd8a
1 parent 6132de0
commit 4b7cd8a
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 101 deletions.
diff --git a/flyteidl/_static/custom.css b/flyteidl/_static/custom.css
diff --git a/flyteidl/conf.py b/flyteidl/conf.py
@@ -122,9 +122,6 @@
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ["_static"]
-html_css_files = [
-    "custom.css",
-]
 
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.

diff --git a/flyteidl/doc-requirements.in b/flyteidl/doc-requirements.in
@@ -1,4 +1,4 @@
-furo
+git+git://github.com/flyteorg/furo@main
 readthedocs-sphinx-search
 sphinx
 sphinx-prompt

diff --git a/flyteidl/doc-requirements.txt b/flyteidl/doc-requirements.txt
@@ -6,7 +6,7 @@
 #
 alabaster==0.7.12
     # via sphinx
-babel==2.9.0
+babel==2.9.1
     # via sphinx
 beautifulsoup4==4.9.3
     # via
@@ -21,7 +21,7 @@ css-html-js-minify==2.5.5
     # via sphinx-material
 docutils==0.16
     # via sphinx
-furo==2021.3.20b30
+git+git://github.com/flyteorg/furo@main
     # via -r doc-requirements.in
 idna==2.10
     # via requests
@@ -63,7 +63,7 @@ sphinx-material==0.0.32
     # via -r doc-requirements.in
 sphinx-prompt==1.4.0
     # via -r doc-requirements.in
-sphinx==3.5.3
+sphinx==3.5.4
     # via
     #   -r doc-requirements.in
     #   furo

diff --git a/flyteidl/index.rst b/flyteidl/index.rst
@@ -17,12 +17,14 @@ This specification is used to generate client stubs for `FlyteKit <https://flyte
    :hidden:
 
    Getting Started <https://docs.flyte.org/en/latest/getting_started.html>
-   Tutorials <https://flytecookbook.readthedocs.io>
-   reference/index
+   User Guide <https://docs.flyte.org/projects/cookbook/en/latest/user_guide.html>
+   Tutorials <https://docs.flyte.org/projects/cookbook/en/latest/tutorials.html>
+   Concepts <https://docs.flyte.org/en/latest/concepts/basics.html>
+   API Reference <https://docs.flyte.org/en/latest/reference/index.html>
    Community <https://docs.flyte.org/en/latest/community/index.html>
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: -1
    :caption: FlyteIDL
    :hidden: