diff --git a/docs/_ext/import_projects.py b/docs/_ext/import_projects.py index df223ee760..1e32aa0d8c 100644 --- a/docs/_ext/import_projects.py +++ b/docs/_ext/import_projects.py @@ -26,6 +26,7 @@ class ImportProjectsConfig: flytekit_api_dir: str source_regex_mapping: dict = field(default_factory=dict) list_table_toc: List[str] = field(default_factory=list) + dev_build: bool = False @dataclass @@ -104,7 +105,7 @@ def update_sys_path_for_flytekit(import_project_config: ImportProjectsConfig): def update_html_context(project: Project, tag: str, commit: str, config: Config): - tag_url = f"{project.source}/releases/tag/{tag}" + tag_url = "#" if tag == "dev" else f"{project.source}/releases/tag/{tag}" commit_url = f"{project.source}/tree/{commit}" config.html_context[f"{project.name}_tag"] = tag @@ -152,9 +153,10 @@ def import_projects(app: Sphinx, config: Config): [t for t in repo.tags if re.match(VERSION_PATTERN, t.name)], key=lambda t: t.commit.committed_datetime ) - if not tags: - # If tags don't exist just use the current commit. This occurs - # when the git repo is a shallow clone. + if not tags or import_projects_config.dev_build: + # If dev_build is specified or the tags don't exist just use the + # current commit. This occurs when the git repo is a shallow + # clone. tag_str = "dev" commit = str(repo.head.commit)[:7] else: diff --git a/docs/conf.py b/docs/conf.py index ed9df55433..05651bf483 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -311,7 +311,7 @@ # from other repos. REPLACE_PATTERNS = { r"": r"", - r"": r"", + r"": r"", INTERSPHINX_REFS_PATTERN: INTERSPHINX_REFS_REPLACE, r"": r"", @@ -337,6 +337,7 @@ "flytesnacks/tutorials", "flytesnacks/integrations", ], + "dev_build": bool(int(os.environ.get("MONODOCS_DEV_BUILD", 1))), } # Define these environment variables to use local copies of the projects. This @@ -444,6 +445,7 @@ def filter(self, record: logging.LogRecord) -> bool: 'Error with CSV data in "csv-table" directive', "Definition list ends without a blank line", "autodoc: failed to import module 'awssagemaker' from module 'flytekitplugins'", + "Enumerated list ends without a blank line", ) if msg.strip().startswith(filter_out): diff --git a/docs/flytectl_overview.rst b/docs/flytectl_overview.rst deleted file mode 100644 index a6d104b08f..0000000000 --- a/docs/flytectl_overview.rst +++ /dev/null @@ -1,107 +0,0 @@ -.. flytectl doc - -#################################################### -Flytectl: The Official Flyte Command-line Interface -#################################################### - -Overview -========= -This video will take you on a tour of Flytectl - how to install and configure it, as well as how to use the Verbs and Nouns sections on the left hand side menu. Detailed information can be found in the sections below the video. - -.. youtube:: cV8ezYnBANE - - -Installation -============ - -Flytectl is a Golang binary that can be installed on any platform supported by Golang. - -.. tabbed:: OSX - - .. prompt:: bash $ - - brew install flyteorg/homebrew-tap/flytectl - - *Upgrade* existing installation using the following command: - - .. prompt:: bash $ - - flytectl upgrade - -.. tabbed:: Other Operating systems - - .. prompt:: bash $ - - curl -sL https://ctl.flyte.org/install | bash - - *Upgrade* existing installation using the following command: - - .. prompt:: bash $ - - flytectl upgrade - -**Test** if Flytectl is installed correctly (your Flytectl version should be > 0.2.0) using the following command: - -.. prompt:: bash $ - - flytectl version - -Configuration -============= - -Flytectl allows you to communicate with FlyteAdmin using a YAML file or by passing every configuration value -on the command-line. The following configuration can be used for the setup: - -Basic Configuration --------------------- - -The full list of available configurable options can be found by running ``flytectl --help``, or `here `__. - -.. NOTE:: - - Currently, the Project ``-p``, Domain ``-d``, and Output ``-o`` flags cannot be used in the config file. - -.. tabbed:: Local Flyte Sandbox - - Automatically configured for you by ``flytectl sandbox`` command. - - .. code-block:: yaml - - admin: - # For GRPC endpoints you might want to use dns:///flyte.myexample.com - endpoint: dns:///localhost:30081 - insecure: true # Set to false to enable TLS/SSL connection (not recommended except on local sandbox deployment). - authType: Pkce # authType: Pkce # if using authentication or just drop this. - -.. tabbed:: AWS Configuration - - .. code-block:: yaml - - admin: - # For GRPC endpoints you might want to use dns:///flyte.myexample.com - endpoint: dns:/// - authType: Pkce # authType: Pkce # if using authentication or just drop this. - insecure: true # insecure: True # Set to true if the endpoint isn't accessible through TLS/SSL connection (not recommended except on local sandbox deployment) - -.. tabbed:: GCS Configuration - - .. code-block:: yaml - - admin: - # For GRPC endpoints you might want to use dns:///flyte.myexample.com - endpoint: dns:/// - authType: Pkce # authType: Pkce # if using authentication or just drop this. - insecure: false # insecure: True # Set to true if the endpoint isn't accessible through TLS/SSL connection (not recommended except on local sandbox deployment) - -.. tabbed:: Others - - For other supported storage backends like Oracle, Azure, etc., refer to the configuration structure `here `__. - - Place the config file in ``$HOME/.flyte`` directory with the name config.yaml. - This file is typically searched in: - - * ``$HOME/.flyte`` - * currDir from where you run flytectl - * ``/etc/flyte/config`` - - You can also pass the file name in the command line using ``--config ``. diff --git a/docs/index.md b/docs/index.md index c2bf0f9087..40a0a745f7 100644 --- a/docs/index.md +++ b/docs/index.md @@ -57,7 +57,7 @@ learning and analytics. Created at [Lyft](https://www.lyft.com/) in collaboration with Spotify, Freenome, and many others, Flyte provides first-class support for -{doc}`Python `, +{doc}`Python `, [Java, and Scala](https://github.com/flyteorg/flytekit-java). Data Scientists and ML Engineers in the industry use Flyte to create: @@ -102,11 +102,11 @@ Below are the API reference to the different components of Flyte: :header-rows: 0 :widths: 20 30 -* - {doc}`Flytekit ` +* - {doc}`Flytekit ` - Flyte's official Python SDK. -* - {doc}`FlyteCTL ` +* - {doc}`FlyteCTL ` - Flyte's command-line interface for interacting with a Flyte cluster. -* - {doc}`FlyteIDL ` +* - {doc}`FlyteIDL ` - Flyte's core specification language. ``` @@ -172,8 +172,8 @@ reference/swagger :name: apitoc :hidden: -flytekit -flytectl +flytekit +flytectl flyteidl ``` diff --git a/docs/reference_flytectl.md b/docs/reference_flytectl.md deleted file mode 100644 index ad1ba6c7a5..0000000000 --- a/docs/reference_flytectl.md +++ /dev/null @@ -1,11 +0,0 @@ -# FlyteCTL API Reference - -```{toctree} -:maxdepth: 2 - -Overview -CLI Entrypoint -flytectl/verbs -flytectl/nouns -flytectl/contribute -``` diff --git a/docs/reference_flytekit.md b/docs/reference_flytekit.md deleted file mode 100644 index 97012a9429..0000000000 --- a/docs/reference_flytekit.md +++ /dev/null @@ -1,20 +0,0 @@ -# Flytekit API Reference - -```{toctree} -:maxdepth: 2 - -api/flytekit/design/index -api/flytekit/flytekit -api/flytekit/configuration -api/flytekit/remote -api/flytekit/clients -api/flytekit/testing -api/flytekit/extend -api/flytekit/deck -api/flytekit/plugins/index -api/flytekit/tasks.extend -api/flytekit/types.extend -api/flytekit/experimental -api/flytekit/pyflyte -api/flytekit/contributing -```