From ba73d892a97d3e4e6bc449d4e2d48f48b10c1334 Mon Sep 17 00:00:00 2001 From: Niels Bantilan Date: Fri, 30 Apr 2021 17:14:21 -0400 Subject: [PATCH] documentation revamp according to RFC (#160) Signed-off-by: cosmicBboy Signed-off-by: Eduardo Apolinario --- flyteidl/_static/custom.css | 91 ----------------------------------- flyteidl/conf.py | 3 -- flyteidl/doc-requirements.in | 2 +- flyteidl/doc-requirements.txt | 6 +-- flyteidl/index.rst | 8 +-- 5 files changed, 9 insertions(+), 101 deletions(-) delete mode 100644 flyteidl/_static/custom.css diff --git a/flyteidl/_static/custom.css b/flyteidl/_static/custom.css deleted file mode 100644 index d9851b7d8f3..00000000000 --- a/flyteidl/_static/custom.css +++ /dev/null @@ -1,91 +0,0 @@ -h1, h2, h3, h4, h5, h6 { - font-weight: bold; -} - -.sidebar-logo { - max-width: 30%; -} - - -.sidebar-tree .reference.external:after { - content: none; -} - -.sphx-glr-thumbcontainer { - background-color: transparent; - border: transparent; -} - -.sphx-glr-thumbcontainer:hover { - border: transparent; -} - -div.sphx-glr-download a { - color:white; - background-color: #9d68e4cf; - background-image: none; - border: 1px solid #9d68e4cf; -} - -div.sphx-glr-download a:hover { - background-color: #8b48e2cf; - box-shadow: none; -} - -div.sphx-glr-thumbcontainer a.headerlink { - display: none; -} - -div.sphx-glr-thumbcontainer:hover { - border-color: white; - box-shadow: none; -} - -.sphx-glr-script-out .highlight pre { - background-color: #f8f8f8; -} - -p.sphx-glr-script-out { - padding-top: 0em; -} - -.search__outer::-webkit-scrollbar-track { - border-radius: 0px; -} - -@media (prefers-color-scheme: dark) { - .search__outer { - background-color: #131416 !important; - border: 1px solid #131416 !important; - } - .search__outer__input { - background-color: #1a1c1e !important; - } - .search__result__single { - border-bottom: #303335 !important; - } - .outer_div_page_results:hover { - background-color: black; - } - .search__result__title, .rtd_ui_search_subtitle { - color: #9D68E4 !important; - border-bottom: 1px solid #9D68E4 !important; - } - .search__outer .search__result__title span, .search__outer .search__result__content span { - background-color: #9d68e454; - } - .search__result__subheading, .search__result__content { - color: #ffffffd9 !important; - } - .search__outer::-webkit-scrollbar-track { - background-color: #131416 !important; - } - .rtd__search__credits { - background-color: #1a1c1e !important; - border: 1px solid #1a1c1e !important; - color: #81868d !important; - } - .rtd__search__credits a, .search__error__box { - color: #9ca0a5 !important; - } - } diff --git a/flyteidl/conf.py b/flyteidl/conf.py index 734bc2f836c..7671d861e5e 100644 --- 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 index 8a0e0881229..3cf9da6f2fb 100644 --- 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 index d01f9385bf7..8df6e8b686b 100644 --- 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 index cf6e78bd23c..3a018e8d26a 100644 --- a/flyteidl/index.rst +++ b/flyteidl/index.rst @@ -17,12 +17,14 @@ This specification is used to generate client stubs for `FlyteKit - Tutorials - reference/index + User Guide + Tutorials + Concepts + API Reference Community .. toctree:: - :maxdepth: 2 + :maxdepth: -1 :caption: FlyteIDL :hidden: