Switch default branch to main and fix tests (#151)

* Switch default branch to main and fix tests

* Last one forgotten

Author: sgugger

.github/workflows/build_main_documentation.yml

@@ -139,9 +139,9 @@ jobs:
             if [[ `git status --porcelain` ]]; then
               git add ${{ inputs.notebook_folder }}
               git commit -m "Updated ${{ inputs.package }} doc notebooks with commit ${{ inputs.commit_sha }} \n\nSee: https://github.com/huggingface/${{ inputs.package }}/commit/${{ inputs.commit_sha }}"
-              git push origin master ||
-              (echo "Failed on the first try, rebasing and pushing again" && git pull --rebase && git push origin master) ||
-              (echo "Failed on the second try, rebasing and pushing again" && git pull --rebase && git push origin master)
+              git push origin main ||
+              (echo "Failed on the first try, rebasing and pushing again" && git pull --rebase && git push origin main) ||
+              (echo "Failed on the second try, rebasing and pushing again" && git pull --rebase && git push origin main)
             else
               echo "No diff in the notebooks."
             fi

kit/README.md

@@ -5,12 +5,12 @@
 - Install `nodejs` / `npm`
 - Run `npm install`
 - Copy the mdx docs into the routes folder
-- set `DOCS_VERSION` in the env to the correct prefix (eg `master`)
+- set `DOCS_VERSION` in the env to the correct prefix (eg `main`)
 - set `DOCS_LANGUAGE` in the env to the correct language (eg `en`)
 - Run `npm run run build`
 
 The generated html files and assets are in the `build` folder.
 
 ## Previewing the docs
 
-Instead of `npm run build`, do `npm run dev`. Then go to http://localhost:3000 (or replace `master` with the correct prefix).
+Instead of `npm run build`, do `npm run dev`. Then go to http://localhost:3000 (or replace `main` with the correct prefix).

kit/svelte.config.js

@@ -39,7 +39,7 @@ const config = {
 				: "/docs/" +
 				  (process.env.DOCS_LIBRARY || "transformers") +
 				  "/" +
-				  (process.env.DOCS_VERSION || "master") +
+				  (process.env.DOCS_VERSION || "main") +
 				  "/" +
 				  (process.env.DOCS_LANGUAGE || "en")
 		}

src/doc_builder/autodoc.py

@@ -280,7 +280,7 @@ def get_source_link(obj, page_info):
     Returns the link to the source code of an object on GitHub.
     """
     package_name = page_info["package_name"]
-    version = page_info.get("version", "master")
+    version = page_info.get("version", "main")
     base_link = f"https://github.com/huggingface/{package_name}/blob/{version}/src/"
     module = obj.__module__.replace(".", "/")
     line_number = inspect.getsourcelines(obj)[1]
@@ -438,7 +438,7 @@ def resolve_links_in_text(text, package, mapping, page_info):
         page_info (`Dict[str, str]`): Some information about the page.
     """
     package_name = page_info.get("package_name", package.__name__)
-    version = page_info.get("version", "master")
+    version = page_info.get("version", "main")
     language = page_info.get("language", "en")
 
     prefix = f"/docs/{package_name}/{version}/{language}/"

src/doc_builder/build_doc.py

@@ -49,7 +49,7 @@ def resolve_open_in_colab(content, page_info):
 
     package_name = page_info["package_name"]
     page_name = Path(page_info["page"]).stem
-    nb_prefix = f"/github/huggingface/notebooks/blob/master/{package_name}_doc/"
+    nb_prefix = f"/github/huggingface/notebooks/blob/main/{package_name}_doc/"
     nb_prefix_colab = f"https://colab.research.google.com{nb_prefix}"
     nb_prefix_awsstudio = f"https://studiolab.sagemaker.aws/import{nb_prefix}"
     links = [
@@ -355,7 +355,7 @@ def build_doc(
     doc_folder,
     output_dir,
     clean=True,
-    version="master",
+    version="main",
     language="en",
     notebook_dir=None,
     is_python_module=False,
@@ -371,7 +371,7 @@ def build_doc(
             The folder in which to put the built documentation. Will be created if it does not exist.
         clean (`bool`, *optional*, defaults to `True`):
             Whether or not to delete the content of the `output_dir` if that directory exists.
-        version (`str`, *optional*, defaults to `"master"`): The name of the version of the doc.
+        version (`str`, *optional*, defaults to `"main"`): The name of the version of the doc.
         language (`str`, *optional*, defaults to `"en"`): The language of the doc.
         notebook_dir (`str` or `os.PathLike`, *optional*):
             If provided, where to save the notebooks generated from the doc file with an [[open-in-colab]] marker.

src/doc_builder/commands/build.py

@@ -171,7 +171,7 @@ def build_command_parser(subparsers=None):
         "--version",
         type=str,
         help="Version of the documentation to generate. Will default to the version of the package module (using "
-        "`master` for a version containing dev).",
+        "`main` for a version containing dev).",
     )
     parser.add_argument("--notebook_dir", type=str, help="Where to save the generated notebooks.", default=None)
     parser.add_argument("--html", action="store_true", help="Whether or not to build HTML files instead of MDX files.")

src/doc_builder/commands/preview.py

@@ -225,7 +225,7 @@ def preview_command_parser(subparsers=None):
         "documentation files should be indicated here.",
     )
     parser.add_argument("--language", type=str, help="Language of the documentation to generate", default="en")
-    parser.add_argument("--version", type=str, help="Version of the documentation to generate", default="master")
+    parser.add_argument("--version", type=str, help="Version of the documentation to generate", default="main")
     parser.add_argument(
         "--not_python_module",
         action="store_true",

src/doc_builder/convert_md_to_mdx.py

@@ -83,7 +83,7 @@ def convert_img_links(text, page_info):
     if "package_name" not in page_info:
         raise ValueError("`page_info` must contain at least the package_name.")
     package_name = page_info["package_name"]
-    version = page_info.get("version", "master")
+    version = page_info.get("version", "main")
     language = page_info.get("language", "en")
 
     _re_img_link = re.compile(r"(src=\"|\()/imgs/")

src/doc_builder/convert_rst_to_mdx.py

@@ -92,7 +92,7 @@ def convert_rst_links(text, page_info):
     if "package_name" not in page_info:
         raise ValueError("`page_info` must contain at least the package_name.")
     package_name = page_info["package_name"]
-    version = page_info.get("version", "master")
+    version = page_info.get("version", "main")
     language = page_info.get("language", "en")
     no_prefix = page_info.get("no_prefix", False)
 
@@ -116,7 +116,7 @@ def convert_rst_links(text, page_info):
 
     # Links with a prefix
     # TODO: when it exists, use the API to deal with prefix links properly.
-    prefix = f"https://github.com/huggingface/{package_name}/tree/master/"
+    prefix = f"https://github.com/huggingface/{package_name}/tree/main/"
     text = _re_prefix_links.sub(rf"[\1]({prefix}\2)", text)
     # Other links
     text = _re_links.sub(r"[\1](\2)", text)
@@ -220,7 +220,7 @@ def convert_rst_blocks(text, page_info):
     if "package_name" not in page_info:
         raise ValueError("`page_info` must contain at least the package_name.")
     package_name = page_info["package_name"]
-    version = page_info.get("version", "master")
+    version = page_info.get("version", "main")
     language = page_info.get("language", "en")
 
     lines = text.split("\n")

src/doc_builder/convert_to_notebook.py

@@ -46,7 +46,7 @@ def expand_links(content, page_info):
     Expand links relative to the documentation to full links to the hf.co website.
     """
     package_name = page_info["package_name"]
-    version = page_info.get("version", "master")
+    version = page_info.get("version", "main")
     language = page_info.get("language", "en")
     page = str(page_info["page"])