Docs for FlyteIDL (#97)

.gitignore

@@ -10,4 +10,4 @@ dist
 gen/pb_python/flyteidl.egg-info/
 
 .virtualgo
-/build/
+docs/build/

.readthedocs.yml

@@ -0,0 +1,16 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: conf.py
+
+# Optionally set the version of Python and requirements required to build your docs
+python:
+  version: 3.8
+  install:
+    - requirements: doc-requirements.txt

Makefile

@@ -2,6 +2,10 @@
 export REPOSITORY=flyteidl
 include boilerplate/lyft/golang_test_targets/Makefile
 
+define PIP_COMPILE
+pip-compile $(1) --upgrade --verbose
+endef
+
 .PHONY: update_boilerplate
 update_boilerplate:
 	@boilerplate/update.sh
@@ -28,3 +32,11 @@ test_unit:
 .PHONY: build_python
 build_python:
 	@python setup.py sdist
+
+.PHONY: install-piptools
+install-piptools:
+	pip install -U pip-tools
+
+.PHONY: doc-requirements.txt
+doc-requirements.txt: doc-requirements.in install-piptools
+	$(call PIP_COMPILE,doc-requirements.in)

README.rst

@@ -1,22 +1,33 @@
 ================
 Flyte IDL
 ================
-This repository contains all of Flyte's IDLs.
+This is one of the core repositories of Flyte and contains the Specification of
+the Flyte Lanugage. The Specification is maintained using Googles fantastic
+Protcol buffers library. The code and docs are auto-generated.
 
-The contents of this Readme will be deprecated shortly.  Please refer to the Flyte `contributor's guide <https://github.com/lyft/flyte>`__ in the future.
+ - [flyte.org](https://flyte.org)
+ - [Flyte Docs](http://flyte.readthedocs.org/)
+ - [FlyteIDL Docs](http://flyteidl.readthedocs.org)
 
-Generating Protobufs -> Code
-#############################
+Generate Code from protobuf
+----------------------------
+#. Make sure docker is installed locally.
+#. Once installed run, ``make generate`` to generate all the code and mock
+   client for FlyteAdmin Service
 
-Mac OS
-*******
+   .. prompt:: bash
 
-1. Install Docker for Mac (https://www.docker.com/docker-mac)
-2. Start 'docker' and sign in.  You should see a whale icon in your toolbar.
-3. cd to the root of your flyteidl repository.
-4. Run ``./generate_protos.sh`` to generate just the protobuf files.  Side note: running ``make generate`` will generate protos along with some other things like mock classes.
+    make generate
 
-Admin Client Generation
-*************************
+#. You might have to run, ``make download_tooling`` to install generator
+   dependencies
 
-Please see the Flyte Tools documentation on the `generator <https://github.com/lyft/flytetools#swagger-client-code-generator>`__ for more information.
+   .. prompt:: bash
+
+   make download_tooling
+
+#. To add new dependencies for a doc, modify ``doc_requirements.in`` and then
+
+   .. prompt:: bash
+
+   make doc-requirements.txt

conf.py

@@ -0,0 +1,194 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/stable/config
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+import os
+import re
+import sys
+
+sys.path.insert(0, os.path.abspath("gen/pb-protodoc/"))
+
+
+# -- Project information -----------------------------------------------------
+
+project = "Flyte Language Specification"
+copyright = "2021, Flyte"
+author = "Flyte"
+
+# The full version, including alpha/beta/rc tags
+release = re.sub('^v', '', os.popen('git describe').read().strip())
+version = release
+
+
+# -- General configuration ---------------------------------------------------
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.autosectionlabel",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.todo",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.doctest",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.coverage",
+    "sphinx-prompt",
+    "sphinx_copybutton",
+]
+
+# build the templated autosummary files
+autosummary_generate = True
+
+# autosectionlabel throws warnings if section names are duplicated.
+# The following tells autosectionlabel to not throw a warning for
+# duplicated section names that are in different documents.
+autosectionlabel_prefix_document = True
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = ".rst"
+
+# The master toctree document.
+master_doc = "index"
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path .
+exclude_patterns = []
+
+# 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
+# a list of builtin themes.
+#
+html_theme = "sphinx_material"
+html_logo = "docs/images/flyte_circle_gradient_1_4x4.png"
+html_theme_options = {
+    # Set the name of the project to appear in the navigation.
+    "nav_title": "Flyte",
+    # Set you GA account ID to enable tracking
+    "google_analytics_account": "G-YQL24L5CKY",
+    # Specify a base_url used to generate sitemap.xml. If not
+    # specified, then no sitemap will be built.
+    "base_url": "https://github.com/lyft/flyteidl",
+    # Set the color and the accent color
+    "color_primary": "deep-purple",
+    "color_accent": "blue",
+    # Set the repo location to get a badge with stats
+    "repo_url": "https://github.com/flyteorg/flyte/",
+    "repo_name": "flyte",
+    # Visible levels of the global TOC; -1 means unlimited
+    "globaltoc_depth": 1,
+    # If False, expand all TOC entries
+    "globaltoc_collapse": False,
+    # If True, show hidden TOC entries
+    "globaltoc_includehidden": False,
+}
+
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+html_sidebars = {"**": ["logo-text.html", "globaltoc.html", "localtoc.html", "searchbox.html"]}
+
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# 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 = []
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = "flyteidldoc"
+
+
+# -- Options for LaTeX output ------------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, "flyteidl.tex", "flyteidl Documentation", "Flyte", "manual"),
+]
+
+
+# -- Options for manual page output ------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [(master_doc, "flyteidl", "flyteidl Documentation", [author], 1)]
+
+
+# -- Options for Texinfo output ----------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (
+        master_doc,
+        "flyteidl",
+        "flyteidl Documentation",
+        author,
+        "flyteidl",
+        "Python SDK for Flyte (https://flyte.org).",
+        "Miscellaneous",
+    ),
+]
+
+
+# -- Extension configuration -------------------------------------------------
+# intersphinx configuration
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/{.major}".format(sys.version_info), None),
+}

developing.rst

@@ -0,0 +1,26 @@
+How to contribute to and develop Flyte IDL
+===========================================
+
+Generate Code from protobuf
+----------------------------
+#. Make sure docker is installed locally.
+#. Once installed run, ``make generate`` to generate all the code and mock
+   client for FlyteAdmin Service
+
+   .. prompt:: bash
+
+     make generate
+
+#. You might have to run, ``make download_tooling`` to install generator
+   dependencies
+
+   .. prompt:: bash
+
+     make download_tooling
+
+#. To add new dependencies for a doc, modify ``doc_requirements.in`` and then
+
+   .. prompt:: bash
+
+     make doc-requirements.txt
+

doc-requirements.in

@@ -0,0 +1,5 @@
+sphinx
+sphinx-prompt
+sphinx-material
+sphinx-code-include
+sphinx-copybutton