diff --git a/docs_infra/in_container_html_generation.sh b/docs_infra/in_container_html_generation.sh deleted file mode 100755 index 54cfd7529ab..00000000000 --- a/docs_infra/in_container_html_generation.sh +++ /dev/null @@ -1,19 +0,0 @@ -#!/bin/bash - -# This file is meant to be run within the docker container, and mounted -# /rsts as the inputs dir -# /docs as the output dir -# /base as the dir where this script lives -# docker run -t -v ${BASEDIR}:/base -v ${BASEDIR}/docs:/docs -v ${BASEDIR}/rsts_tmp:/rsts lyft/docbuilder:v2.2.0 /base/docs_infra/in_container_html_generation.sh -# -# It will expect flyteidl and flytekit checked out at the /repos folder. - -set -e -set -x - -# We're generating documentation for flytekit, which references flyteidl. autodoc complains if the python libraries -# referenced are not installed, so let's install them -echo "Installing flytekit==${FLYTEKIT_VERSION}" -pip install -U flytekit[all]==${FLYTEKIT_VERSION} - -sphinx-build -Q -b html -c /rsts /rsts /docs/ diff --git a/docs_infra/in_container_rst_generation.sh b/docs_infra/in_container_rst_generation.sh deleted file mode 100755 index 8289e96f3cf..00000000000 --- a/docs_infra/in_container_rst_generation.sh +++ /dev/null @@ -1,25 +0,0 @@ -#!/bin/bash - -# This file is meant to be run within the docker container that has the appropriate repos checked out, and mounted -# docker run -t -v ${BASEDIR}:/base -v ${REPOS_DIR}:/repos -v ${BASEDIR}/_rsts:/_rsts lyft/docbuilder:v2.2.0 /base/docs_infra/in_container_rst_generation.sh -# -# It will expect flyteidl and flytekit checked out at the /repos folder. - -set -e -set -x - -# We're generating documentation for flytesdk, which references flyteidl. autodoc complains if the python libraries -# referenced are not installed, so let's install them -pip install -U flytekit[all-spark3]==${FLYTEKIT_VERSION} - -# Generate the RST files for flytekit -sphinx-apidoc --force --tocfile index --ext-autodoc --output-dir /repos/flytekit/docs /repos/flytekit/flytekit - -# Create a temp directory where we can aggregate all the rst files from all locations -mkdir /rsts - -# The toctree in this index file requires that the idl/sdk rsts are in the same folder -cp -R /repos/flyteidl/gen/pb-protodoc/flyteidl /rsts/ -cp -R /repos/flytekit/docs /rsts/flytekit - -cp -R /rsts/* /_rsts diff --git a/rsts/conf.py b/rsts/conf.py index 086e79de915..bf7e909a381 100644 --- a/rsts/conf.py +++ b/rsts/conf.py @@ -20,7 +20,7 @@ project = u'Flyte' copyright = u'2020, Flyte Authors' -author = u'Flyte Authors' +author = u'Flyte' # The short X.Y version version = u'' @@ -90,9 +90,6 @@ # This pattern also affects html_static_path and html_extra_path . exclude_patterns = [u'_build', 'Thumbs.db', '.DS_Store'] -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - # -- Options for HTML output ------------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for @@ -122,6 +119,14 @@ "globaltoc_collapse": False, # If True, show hidden TOC entries "globaltoc_includehidden": False, + "nav_links": [ + {"href": "index", "internal": True, "title": "Flyte Docs"}, + { + "href": "https://flytecookbook.readthedocs.io", + "internal": False, + "title": "Flyte Tutorials", + }, + ], } # Theme options are theme-specific and customize the look and feel of a theme