Add automatic version tagging to Docker CI Pushes (#2132)

[etc/vim.git] / docs / conf.py

diff --git a/docs/conf.py b/docs/conf.py
index 8dd77b41d6149f4afa39b56390af1ada12052c8d..ec6aad9a27b4c26f39c271505280b31de4ab143a 100644 (file)
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -15,7 +15,7 @@
 from pathlib import Path
 import re
 import string
 from pathlib import Path
 import re
 import string

-from typing import Callable, List, Optional, Pattern, Tuple, Set
+from typing import Callable, Dict, List, Optional, Pattern, Tuple, Set

 from dataclasses import dataclass
 import logging
 
 from dataclasses import dataclass
 import logging
 


@@ -99,7 +99,13 @@ def get_contents(section: DocSection) -> str:
         for lineno, line in enumerate(f, start=1):
             if lineno >= start_line and lineno < end_line:
                 contents.append(line)
         for lineno, line in enumerate(f, start=1):
             if lineno >= start_line and lineno < end_line:
                 contents.append(line)

-    return "".join(contents)
+    result = "".join(contents)
+    # Let's make Prettier happy with the amount of trailing newlines in the sections.
+    if result.endswith("\n\n"):
+        result = result[:-1]
+    if not result.endswith("\n"):
+        result = result + "\n"
+    return result

 
 
 def get_sections_from_readme() -> List[DocSection]:
 
 
 def get_sections_from_readme() -> List[DocSection]:


@@ -159,18 +165,19 @@ def process_sections(
     It processes custom sections before the README generated sections so sections in the
     README can be overwritten with custom options.
     """
     It processes custom sections before the README generated sections so sections in the
     README can be overwritten with custom options.
     """

-    processed_sections: Set[str] = set()
+    processed_sections: Dict[str, DocSection] = {}

     modified_files: Set[Path] = set()
     sections: List[DocSection] = custom_sections
     sections.extend(readme_sections)
     for section in sections:
     modified_files: Set[Path] = set()
     sections: List[DocSection] = custom_sections
     sections.extend(readme_sections)
     for section in sections:

-        LOG.info(f"Processing '{section.name}' from {section.src}")

         if section.name in processed_sections:
         if section.name in processed_sections:

-            LOG.info(
+            LOG.warning(

                 f"Skipping '{section.name}' from '{section.src}' as it is a duplicate"
                 f"Skipping '{section.name}' from '{section.src}' as it is a duplicate"

+                f" of a custom section from '{processed_sections[section.name].src}'"

             )
             continue
 
             )
             continue
 

+        LOG.info(f"Processing '{section.name}' from '{section.src}'")

         target_path: Path = CURRENT_DIR / section.get_out_filename()
         if target_path in modified_files:
             LOG.warning(
         target_path: Path = CURRENT_DIR / section.get_out_filename()
         if target_path in modified_files:
             LOG.warning(


@@ -188,7 +195,7 @@ def process_sections(
                 rel = section.src.resolve().relative_to(CURRENT_DIR.parent)
                 f.write(f'[//]: # "NOTE: THIS FILE WAS AUTOGENERATED FROM {rel}"\n\n')
             f.write(contents)
                 rel = section.src.resolve().relative_to(CURRENT_DIR.parent)
                 f.write(f'[//]: # "NOTE: THIS FILE WAS AUTOGENERATED FROM {rel}"\n\n')
             f.write(contents)

-        processed_sections.add(section.name)
+        processed_sections[section.name] = section

         modified_files.add(target_path)
 
 
         modified_files.add(target_path)
 
 


@@ -212,7 +219,6 @@ custom_sections = [
     DocSection("blackd", CURRENT_DIR / "blackd.md"),
     DocSection("black_primer", CURRENT_DIR / "black_primer.md"),
     DocSection("contributing_to_black", CURRENT_DIR / ".." / "CONTRIBUTING.md"),
     DocSection("blackd", CURRENT_DIR / "blackd.md"),
     DocSection("black_primer", CURRENT_DIR / "black_primer.md"),
     DocSection("contributing_to_black", CURRENT_DIR / ".." / "CONTRIBUTING.md"),

-    DocSection("change_log", CURRENT_DIR / ".." / "CHANGES.md"),

 ]
 
 # Sphinx complains when there is a source file that isn't referenced in any of the docs.
 ]
 
 # Sphinx complains when there is a source file that isn't referenced in any of the docs.


@@ -224,6 +230,7 @@ blocklisted_sections_from_readme = {
     "pragmatism",
     "testimonials",
     "used_by",
     "pragmatism",
     "testimonials",
     "used_by",

+    "change_log",

 }
 
 make_pypi_svg(release)
 }
 
 make_pypi_svg(release)