Fix index links (#14567)

* Fix links in README * Localized READMEs * Fix copy script * Fix find doc script * Update README_ko.md Co-authored-by: Julien Chaumond <julien@huggingface.co> Co-authored-by: Julien Chaumond <julien@huggingface.co>
huggingface · Dec 1, 2021 · 370d1c9 · 370d1c9
1 parent 93cdd26
commit 370d1c9
Show file tree

Hide file tree

Showing 7 changed files with 487 additions and 480 deletions.
diff --git a/README.md b/README.md
diff --git a/README_ko.md b/README_ko.md
diff --git a/README_zh-hans.md b/README_zh-hans.md
diff --git a/README_zh-hant.md b/README_zh-hant.md
diff --git a/docs/source/index.mdx b/docs/source/index.mdx
diff --git a/utils/check_copies.py b/utils/check_copies.py
@@ -328,6 +328,11 @@ def _rep(match):
     return num_models_equal, "\n".join(map(lambda x: x[1], sorted_index)) + "\n"
 
 
+def convert_readme_to_index(model_list):
+    model_list = model_list.replace("https://huggingface.co/docs/transformers/master/", "")
+    return model_list.replace("https://huggingface.co/docs/transformers/", "")
+
+
 def _find_text_in_file(filename, start_prompt, end_prompt):
     """
     Find the text in `filename` between a line beginning with `start_prompt` and before `end_prompt`, removing empty
@@ -380,10 +385,11 @@ def check_model_list_copy(overwrite=False, max_per_line=119):
 
         converted_md_lists.append((filename, num_models_equal, converted_md_list, _start_prompt, _end_prompt))
 
-    if md_list != index_list:
+    converted_md_list = convert_readme_to_index(md_list)
+    if converted_md_list != index_list:
         if overwrite:
             with open(os.path.join(PATH_TO_DOCS, "index.mdx"), "w", encoding="utf-8", newline="\n") as f:
-                f.writelines(lines[:start_index] + [md_list] + lines[end_index:])
+                f.writelines(lines[:start_index] + [converted_md_list] + lines[end_index:])
         else:
             raise ValueError(
                 "The model list in the README changed and the list in `index.mdx` has not been updated. Run "

diff --git a/utils/check_repo.py b/utils/check_repo.py
@@ -458,6 +458,11 @@ def find_all_documented_objects():
             content = f.read()
         raw_doc_objs = re.findall(r"(?:autoclass|autofunction):: transformers.(\S+)\s+", content)
         documented_obj += [obj.split(".")[-1] for obj in raw_doc_objs]
+    for doc_file in Path(PATH_TO_DOC).glob("**/*.mdx"):
+        with open(doc_file, "r", encoding="utf-8", newline="\n") as f:
+            content = f.read()
+        raw_doc_objs = re.findall("\[\[autodoc\]\]\s+(\S+)\s+", content)
+        documented_obj += [obj.split(".")[-1] for obj in raw_doc_objs]
     return documented_obj