mirror of
				https://github.com/python/cpython.git
				synced 2025-10-31 05:31:20 +00:00 
			
		
		
		
	Doc: Upgrade Sphinx to 8.1 (#125276)
This commit is contained in:
		
							parent
							
								
									427dcf24de
								
							
						
					
					
						commit
						dd0ee201da
					
				
					 2 changed files with 25 additions and 8 deletions
				
			
		
							
								
								
									
										31
									
								
								Doc/conf.py
									
										
									
									
									
								
							
							
						
						
									
										31
									
								
								Doc/conf.py
									
										
									
									
									
								
							|  | @ -11,6 +11,8 @@ | |||
| import sys | ||||
| import time | ||||
| 
 | ||||
| import sphinx | ||||
| 
 | ||||
| sys.path.append(os.path.abspath('tools/extensions')) | ||||
| sys.path.append(os.path.abspath('includes')) | ||||
| 
 | ||||
|  | @ -62,7 +64,10 @@ | |||
| 
 | ||||
| # General substitutions. | ||||
| project = 'Python' | ||||
| copyright = f"2001-{time.strftime('%Y')}, Python Software Foundation" | ||||
| if sphinx.version_info[:2] >= (8, 1): | ||||
|     copyright = "2001-%Y, Python Software Foundation" | ||||
| else: | ||||
|     copyright = f"2001-{time.strftime('%Y')}, Python Software Foundation" | ||||
| 
 | ||||
| # We look for the Include/patchlevel.h file in the current Python source tree | ||||
| # and replace the values accordingly. | ||||
|  | @ -361,10 +366,14 @@ | |||
| } | ||||
| 
 | ||||
| # This 'Last updated on:' timestamp is inserted at the bottom of every page. | ||||
| html_time = int(os.environ.get('SOURCE_DATE_EPOCH', time.time())) | ||||
| html_last_updated_fmt = time.strftime( | ||||
|     '%b %d, %Y (%H:%M UTC)', time.gmtime(html_time) | ||||
| ) | ||||
| html_last_updated_fmt = '%b %d, %Y (%H:%M UTC)' | ||||
| if sphinx.version_info[:2] >= (8, 1): | ||||
|     html_last_updated_use_utc = True | ||||
| else: | ||||
|     html_time = int(os.environ.get('SOURCE_DATE_EPOCH', time.time())) | ||||
|     html_last_updated_fmt = time.strftime( | ||||
|         html_last_updated_fmt, time.gmtime(html_time) | ||||
|     ) | ||||
| 
 | ||||
| # Path to find HTML templates. | ||||
| templates_path = ['tools/templates'] | ||||
|  | @ -596,13 +605,21 @@ | |||
| # mapping unique short aliases to a base URL and a prefix. | ||||
| # https://www.sphinx-doc.org/en/master/usage/extensions/extlinks.html | ||||
| extlinks = { | ||||
|     "cve": ("https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-%s", "CVE-%s"), | ||||
|     "cwe": ("https://cwe.mitre.org/data/definitions/%s.html", "CWE-%s"), | ||||
|     "pypi": ("https://pypi.org/project/%s/", "%s"), | ||||
|     "source": (SOURCE_URI, "%s"), | ||||
| } | ||||
| extlinks_detect_hardcoded_links = True | ||||
| 
 | ||||
| if sphinx.version_info[:2] < (8, 1): | ||||
|     # Sphinx 8.1 has in-built CVE and CWE roles. | ||||
|     extlinks |= { | ||||
|         "cve": ( | ||||
|             "https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-%s", | ||||
|             "CVE-%s", | ||||
|         ), | ||||
|         "cwe": ("https://cwe.mitre.org/data/definitions/%s.html", "CWE-%s"), | ||||
|     } | ||||
| 
 | ||||
| # Options for c_annotations | ||||
| # ------------------------- | ||||
| 
 | ||||
|  |  | |||
		Loading…
	
	Add table
		Add a link
		
	
		Reference in a new issue
	
	 Adam Turner
						Adam Turner