Skip to content
This repository has been archived by the owner on May 31, 2024. It is now read-only.

add flytectl docs redirects to monodocs #454

Merged
merged 1 commit 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
1 change: 1 addition & 0 deletions doc-requirements.in
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,4 @@ sphinx-copybutton
sphinx_fontawesome
sphinxcontrib-youtube
sphinx-panels
sphinx-reredirects
70 changes: 36 additions & 34 deletions doc-requirements.txt
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
#
# This file is autogenerated by pip-compile with python 3.8
# To update, run:
# This file is autogenerated by pip-compile with Python 3.10
# by the following command:
#
# pip-compile doc-requirements.in
#
alabaster==0.7.12
alabaster==0.7.16
# via sphinx
babel==2.9.1
babel==2.14.0
# via sphinx
beautifulsoup4==4.10.0
beautifulsoup4==4.12.2
# via
# furo
# sphinx-code-include
# sphinx-material
certifi==2023.7.22
certifi==2023.11.17
# via requests
charset-normalizer==2.0.10
charset-normalizer==3.3.2
# via requests
css-html-js-minify==2.5.5
# via sphinx-material
Expand All @@ -25,79 +25,81 @@ docutils==0.17.1
# sphinx-panels
furo @ git+https://github.com/flyteorg/furo@main
# via -r doc-requirements.in
idna==3.3
idna==3.6
# via requests
imagesize==1.3.0
imagesize==1.4.1
# via sphinx
jinja2==3.0.3
jinja2==3.1.3
# via sphinx
lxml==4.9.1
lxml==5.1.0
# via sphinx-material
markupsafe==2.0.1
markupsafe==2.1.3
# via jinja2
packaging==21.3
packaging==23.2
# via sphinx
pygments==2.11.2
pygments==2.17.2
# via
# furo
# sphinx
# sphinx-prompt
pyparsing==3.0.6
# via packaging
python-slugify[unidecode]==5.0.2
python-slugify[unidecode]==8.0.1
# via sphinx-material
pytz==2021.3
# via babel
requests==2.27.1
# via sphinx
requests==2.31.0
# via
# sphinx
# sphinxcontrib-youtube
six==1.16.0
# via sphinx-code-include
snowballstemmer==2.2.0
# via sphinx
soupsieve==2.3.1
soupsieve==2.5
# via beautifulsoup4
sphinx==4.3.2
sphinx==4.5.0
# via
# -r doc-requirements.in
# furo
# sphinx-basic-ng
# sphinx-code-include
# sphinx-copybutton
# sphinx-fontawesome
# sphinx-material
# sphinx-panels
# sphinx-prompt
# sphinxcontrib-yt
# sphinx-reredirects
# sphinxcontrib-youtube
sphinx-basic-ng==1.0.0b2
# via furo
sphinx-code-include==1.1.1
# via -r doc-requirements.in
sphinx-copybutton==0.4.0
sphinx-copybutton==0.5.2
# via -r doc-requirements.in
sphinx-fontawesome==0.0.6
# via -r doc-requirements.in
sphinx-material==0.0.35
sphinx-material==0.0.36
# via -r doc-requirements.in
sphinx-panels==0.6.0
# via -r doc-requirements.in
sphinx-prompt==1.5.0
# via -r doc-requirements.in
sphinxcontrib-applehelp==1.0.2
sphinx-reredirects==0.1.3
# via -r doc-requirements.in
sphinxcontrib-applehelp==1.0.4
# via sphinx
sphinxcontrib-devhelp==1.0.2
# via sphinx
sphinxcontrib-htmlhelp==2.0.0
sphinxcontrib-htmlhelp==2.0.1
# via sphinx
sphinxcontrib-jsmath==1.0.1
# via sphinx
sphinxcontrib-qthelp==1.0.3
# via sphinx
sphinxcontrib-serializinghtml==1.1.5
# via sphinx
sphinxcontrib-youtube==1.2.0
sphinxcontrib-youtube==1.3.0
# via -r doc-requirements.in
text-unidecode==1.3
# via python-slugify
unidecode==1.3.2
unidecode==1.3.8
# via python-slugify
urllib3==1.26.7
urllib3==2.1.0
# via requests

# The following packages are considered to be unsafe in a requirements file:
# setuptools
10 changes: 10 additions & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@
"sphinx_copybutton",
"sphinx_fontawesome",
"sphinxcontrib.youtube",
"sphinx_reredirects",
"sphinx_panels",
]

Expand Down Expand Up @@ -201,3 +202,12 @@
"flyteidl": ("https://docs.flyte.org/projects/flyteidl/en/latest", None),
"flyte": ("https://docs.flyte.org/en/latest", None),
}

if int(os.environ.get("ENABLE_SPHINX_REDIRECTS", 0)):
# Redirects to the new docs site
redirects = {
"verbs.html": "https://docs.flyte.org/en/latest/flytectl/verbs.html",
"nouns.html": "https://docs.flyte.org/en/latest/flytectl/nouns.html",
"gen/*": "https://docs.flyte.org/en/latest/flytectl/$source.html",
"contribute.html": "https://docs.flyte.org/en/latest/flytectl/contribute.html",
}
1 change: 1 addition & 0 deletions docs/source/gen/flytectl.rst

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions docs/source/gen/flytectl_compile.rst

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions docs/source/gen/flytectl_completion.rst

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions docs/source/gen/flytectl_config.rst

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions docs/source/gen/flytectl_config_discover.rst

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 3 additions & 2 deletions docs/source/gen/flytectl_config_docs.rst

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions docs/source/gen/flytectl_config_init.rst

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions docs/source/gen/flytectl_config_validate.rst

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions docs/source/gen/flytectl_create.rst

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

34 changes: 27 additions & 7 deletions docs/source/gen/flytectl_create_execution.rst

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions docs/source/gen/flytectl_create_project.rst

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading