Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add monodocs index page in flytekit #2100

Merged
merged 2 commits into from
Jan 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -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 -------------------------------------------------

Expand Down
22 changes: 22 additions & 0 deletions docs/source/docs_index.rst
Original file line number Diff line number Diff line change
@@ -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
5 changes: 5 additions & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Loading