diff --git a/doc-requirements.in b/doc-requirements.in index 6d288ac2e7..609042e8d1 100644 --- a/doc-requirements.in +++ b/doc-requirements.in @@ -8,3 +8,4 @@ sphinx-copybutton sphinx-tabs sphinxext-remoteliteralinclude sphinx-issues +sphinx_fontawesome diff --git a/doc-requirements.txt b/doc-requirements.txt index cd18b68296..bc6b2635d6 100644 --- a/doc-requirements.txt +++ b/doc-requirements.txt @@ -36,7 +36,7 @@ markupsafe==1.1.1 # via jinja2 packaging==20.9 # via sphinx -pygments==2.8.1 +pygments==2.9.0 # via # sphinx # sphinx-prompt @@ -51,7 +51,7 @@ readthedocs-sphinx-search==0.1.0 # via -r doc-requirements.in requests==2.25.1 # via sphinx -six==1.15.0 +six==1.16.0 # via # sphinx-code-include # sphinxext-remoteliteralinclude @@ -65,6 +65,8 @@ sphinx-code-include==1.1.1 # via -r doc-requirements.in sphinx-copybutton==0.3.1 # via -r doc-requirements.in +sphinx-fontawesome==0.0.6 + # via -r doc-requirements.in sphinx-issues==1.2.0 # via -r doc-requirements.in sphinx-prompt==1.4.0 @@ -78,6 +80,7 @@ sphinx==3.5.4 # sphinx-autoapi # sphinx-code-include # sphinx-copybutton + # sphinx-fontawesome # sphinx-issues # sphinx-prompt # sphinx-tabs diff --git a/rsts/conf.py b/rsts/conf.py index c1414823a1..65a4820778 100644 --- a/rsts/conf.py +++ b/rsts/conf.py @@ -18,6 +18,7 @@ import sphinx.application import sphinx.errors +import sphinx_fontawesome sphinx.application.ExtensionError = sphinx.errors.ExtensionError # -- Project information ----------------------------------------------------- @@ -60,6 +61,7 @@ "sphinxext.remoteliteralinclude", "sphinx_issues", "sphinx_search.extension", + "sphinx_fontawesome", ] extlinks = { @@ -120,6 +122,13 @@ "color-brand-primary": "#9D68E4", "color-brand-content": "#9D68E4", }, + # custom flyteorg furo theme options + "github_repo": "flytesnacks", + "github_username": "flyteorg", + "github_commit": "master", + "docs_path": "cookbook/docs", # path to documentation source + "sphinx_gallery_src_dir": "cookbook", # path to directory of sphinx gallery source files relative to repo root + "sphinx_gallery_dest_dir": "auto", # path to root directory containing auto-generated sphinx gallery examples } # Theme options are theme-specific and customize the look and feel of a theme diff --git a/rsts/index.rst b/rsts/index.rst index 5806d86e1e..561f879513 100644 --- a/rsts/index.rst +++ b/rsts/index.rst @@ -6,12 +6,12 @@ :titlesonly: :hidden: - getting_started - User Guide - Tutorials - Concepts - API Reference - community/index + |plane| Getting Started + |book-reader| User Guide + |chalkboard| Tutorials + |project-diagram| Concepts + |book| API Reference + |hands-helping| community/index .. toctree:: :caption: Concepts