diff --git a/docs/source/conf.py b/docs/source/conf.py index 16c5165296..09eb276ca0 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -96,7 +96,7 @@ # 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 = [] +exclude_patterns = ["docs_index.rst"] # -- Options for HTML output ------------------------------------------------- diff --git a/docs/source/docs_index.rst b/docs/source/docs_index.rst new file mode 100644 index 0000000000..dbbf95af83 --- /dev/null +++ b/docs/source/docs_index.rst @@ -0,0 +1,22 @@ +********************** +Flytekit API Reference +********************** + +.. toctree:: + :maxdepth: 2 + + design/index + flytekit + configuration + remote + clients + testing + extras.accelerators + extend + deck + plugins/index + tasks.extend + types.extend + experimental + pyflyte + contributing diff --git a/docs/source/index.rst b/docs/source/index.rst index 7262d7668e..d4d0730236 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,3 +1,8 @@ +.. DO NOT EDIT THIS FILE! + This file is the index for the old flytekit documentation. The index for the monodocs is now + at `docs_index.rst`. Please edit that file if you want to add new entries to the flytekit api + documentation. + .. simpleble documentation master file, created by sphinx-quickstart on Fri Mar 9 04:07:53 2018. You can adapt this file completely to your liking, but it should at least