Rename the default branch to main

.github/workflows/deploy.yml

@@ -1,7 +1,7 @@
 name: Deploy
 on:
   push:
-    branches: [master]
+    branches: [main]
 
 jobs:
   docs:

README.md

@@ -3,7 +3,7 @@
   A clean customizable theme for <a href="https://www.sphinx-doc.org/">Sphinx</a>.
 </p>
 <a href="https://pradyunsg.me/furo/">
-  <img align="center" src="https://github.com/pradyunsg/furo/raw/master/docs/_static/demo.png" alt="Demo image">
+  <img align="center" src="https://github.com/pradyunsg/furo/raw/main/docs/_static/demo.png" alt="Demo image">
 </a>
 
 ## Quickstart

docs/contributing/index.md

@@ -23,4 +23,4 @@ design-goals
 [Design Goals](./design-goals)
 : Describes the priorities for this theme's design.
 
-[code of conduct]: https://github.com/pradyunsg/furo/blob/master/CODE_OF_CONDUCT.md
+[code of conduct]: https://github.com/pradyunsg/furo/blob/main/CODE_OF_CONDUCT.md

docs/customisation/index.md

@@ -67,6 +67,6 @@ If you want more control than what is provided by the above theme options, you c
 ReadTheDocs has an excellent explanation on [how to add custom CSS files][sphinx-custom-css] to Sphinx-based documentation.
 
 [css-variables]: https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_custom_properties
-[sphinx-html-theme-options]: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_theme_options
+[sphinx-html-theme-options]: https://www.sphinx-doc.org/en/main/usage/configuration.html#confval-html_theme_options
 [sphinx-custom-css]: https://docs.readthedocs.io/en/stable/guides/adding-custom-css.html
-[sphinx-file-wide-metadata]: https://www.sphinx-doc.org/en/master/usage/restructuredtext/field-lists.html#metadata
+[sphinx-file-wide-metadata]: https://www.sphinx-doc.org/en/main/usage/restructuredtext/field-lists.html#metadata

docs/customisation/landing-page.md

@@ -15,4 +15,4 @@ You'll need to write HTML for the page in `_templates/your-custom-landing-page.h
 
 In case you're curious, this works because Sphinx allows overwriting existing files when generating the website and processes `html_additional_pages` _after_ processing the pages normally. These two behaviours combined mean that we can overwrite the page generated with the default layout by specifying the same document with a different template in `html_additional_pages`.
 
-[additional-pages]: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_additional_pages
+[additional-pages]: https://www.sphinx-doc.org/en/main/usage/configuration.html#confval-html_additional_pages

docs/customisation/logo.md

@@ -8,4 +8,4 @@ html_logo = "logo.png"
 
 It is also possible to [hide the name of the project in the sidebar](customisation/index.md#sidebar_hide_name), which might be desirable if the logo contains the project name.
 
-[sphinx-html_logo]: https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-html_logo
+[sphinx-html_logo]: https://www.sphinx-doc.org/en/main/usage/configuration.html#confval-html_logo

docs/customisation/toc.md

@@ -23,4 +23,4 @@ hide-toc: true
 ```
 ````
 
-[sphinx-file-wide-metadata]: https://www.sphinx-doc.org/en/master/usage/restructuredtext/field-lists.html#metadata
+[sphinx-file-wide-metadata]: https://www.sphinx-doc.org/en/main/usage/restructuredtext/field-lists.html#metadata

noxfile.py

@@ -123,7 +123,7 @@ def release(session):
     session.run("release-helper", "version-check-validity", next_version)
     session.run("release-helper", "directory-check-empty", "dist")
 
-    session.run("release-helper", "git-check-branch", "master")
+    session.run("release-helper", "git-check-branch", "main")
     session.run("release-helper", "git-check-clean")
     session.run("release-helper", "git-check-tag", release_version, "--does-not-exist")
     session.run("release-helper", "git-check-remote", "origin", *allowed_upstreams)
@@ -154,7 +154,7 @@ def release(session):
     session.run("git", "commit", "-m", "Back to development", external=True)
 
     # Push the commits and tag.
-    session.run("git", "push", "origin", "master", release_version, external=True)
+    session.run("git", "push", "origin", "main", release_version, external=True)
 
     # Upload the distributions.
     session.run("twine", "upload", *glob.glob("dist/*"))