diff --git a/docs/source/conf.py b/docs/source/conf.py index 4115e42a..cafa9e7d 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -218,24 +218,24 @@ ogp_use_first_image = True # document is moved internally, a redirect link should be configured as below to # help us not break links. # -# The workflow for adding redirects can be as follows: +# The workflow for adding redirects can be as follows: # 1. Change "rediraffe_branch" below to point to the commit/ branch you -# want to make the changes based off. +# want to make the changes based off. # 2. Option 1: run "make rediraffecheckdiff" # a. Analyze the output of this command # b. Manually add the redirect entries to the "redirects.txt" file. # Option 2: run "rediraffewritediff" # a. rediraffe will then automatically add the obvious redirects to redirects.txt -# b. Analyze the output of the command for broken links. -# c. Check the "redirects.txt" file for any files that were moved/ renamed but are not listed. +# b. Analyze the output of the command for broken links. +# c. Check the "redirects.txt" file for any files that were moved/ renamed but are not listed. # d. Manually add the redirects that havebeen mised by the automatic builder to "redirects.txt" -# Option 3: Do not use the commands above and, instead, do everything manually - by taking +# Option 3: Do not use the commands above and, instead, do everything manually - by taking # note of of the files you have moved or renamed and adding them to the "redirects.txt" file. -# -# If you are basing changes off another branch/ commit, always change back -# rediraffe_branch to main before pushing your changes upstream. # -rediraffe_branch = "main" +# If you are basing changes off another branch/ commit, always change back +# rediraffe_branch to main before pushing your changes upstream. +# +rediraffe_branch = "main" rediraffe_redirects = "redirects.txt" # rediraffe_redirects = { # "old-file": "new-folder/new-file-name", diff --git a/docs/source/redirects.txt b/docs/source/redirects.txt index e08f7090..ad10ee8e 100644 --- a/docs/source/redirects.txt +++ b/docs/source/redirects.txt @@ -16,6 +16,3 @@ "admin/upgrading.md" "howto/upgrading.md" "installation-basics.md" "tutorial/installation/installation-basics.md" "quickstart.md" "tutorial/installation/quickstart.md" - - -