From a8ffa9617f3bd3826267709028d8c4d4d871c650 Mon Sep 17 00:00:00 2001 From: Geoff Hutchison Date: Sun, 3 Dec 2023 09:49:58 -0500 Subject: [PATCH] Add redirect extension to the builds --- .github/workflows/build.yml | 2 +- source/conf.py | 5 +++++ source/docs/index.md | 2 +- source/redirects.txt | 1 + 4 files changed, 8 insertions(+), 2 deletions(-) create mode 100644 source/redirects.txt diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 1e5f02cb..96aa5a1d 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -40,7 +40,7 @@ jobs: - name: Install Sphinx and requirements run: | - pip install -U sphinx myst-parser breathe pydata-sphinx-theme sphinx-design sphinx-copybutton linkify-it-py pygments + pip install -U sphinx myst-parser breathe pydata-sphinx-theme sphinxext-rediraffe sphinx-design sphinx-copybutton linkify-it-py pygments - name: Configure run: | diff --git a/source/conf.py b/source/conf.py index 9fe216b3..724b9f02 100644 --- a/source/conf.py +++ b/source/conf.py @@ -44,6 +44,7 @@ 'sphinx.ext.githubpages', 'sphinx.ext.ifconfig', 'sphinx.ext.intersphinx', + 'sphinxext.rediraffe', 'sphinx.ext.mathjax', 'sphinx.ext.napoleon', 'sphinx.ext.viewcode', @@ -68,6 +69,10 @@ "tasklist", ] +# set up redirects +rediraffe_branch = 'main' +rediraffe_redirects = "redirects.txt" + # Make sure icons show in LaTeX / PDF output sd_fontawesome_latex = True diff --git a/source/docs/index.md b/source/docs/index.md index ed33363b..18dd6b03 100644 --- a/source/docs/index.md +++ b/source/docs/index.md @@ -1,6 +1,6 @@ (Guide)= -# Introduction +# User Guide Avogadro is a free, open source molecular editor and visualization tool, designed for use on Mac, Windows, and Linux in computational chemistry, molecular modeling, bioinformatics, materials science, and related areas. It offers flexible high quality rendering and a powerful plugin architecture. diff --git a/source/redirects.txt b/source/redirects.txt new file mode 100644 index 00000000..13d44264 --- /dev/null +++ b/source/redirects.txt @@ -0,0 +1 @@ +'api/index.rst' 'develop/index.md'