From 5787b613f6b7bf1c00f81eab213f0a896ea5328e Mon Sep 17 00:00:00 2001 From: Sam Wu Date: Mon, 13 Mar 2023 12:20:47 -0600 Subject: [PATCH] Add 404 page (#1933) * Add 404 page Only build htmlzip format for docs * Add homepage link to 404 page --- .gitignore | 11 +++++++++-- .readthedocs.yaml | 2 +- docs/404.md | 5 +++++ docs/conf.py | 4 ---- 4 files changed, 15 insertions(+), 7 deletions(-) create mode 100644 docs/404.md diff --git a/.gitignore b/.gitignore index b67a2bce1..72057994a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,11 @@ -_build .venv .vscode -build \ No newline at end of file +build + +# documentation artifacts +_build/ +_images/ +_static/ +_templates/ +_toc.yml +docBin/ diff --git a/.readthedocs.yaml b/.readthedocs.yaml index d751197bf..43a0890c9 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -6,7 +6,7 @@ version: 2 sphinx: configuration: docs/conf.py -formats: all +formats: [htmlzip] python: version: "3.8" diff --git a/docs/404.md b/docs/404.md new file mode 100644 index 000000000..321758b12 --- /dev/null +++ b/docs/404.md @@ -0,0 +1,5 @@ +# 404 Page Not Found + +Page could not be found. + +Return to [home](index) or please use the links from the sidebar to find what you are looking for. diff --git a/docs/conf.py b/docs/conf.py index 5be7ed5ee..d8204c175 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -4,10 +4,6 @@ # list see the documentation: # https://www.sphinx-doc.org/en/master/usage/configuration.html -import shutil -shutil.copy2('../CHANGELOG.md','./') -shutil.copy2('../RELEASE.md','./') - from rocm_docs import ROCmDocs docs_core = ROCmDocs("ROCm Documentation")