Lerking/Phoenix
1
0
Fork 0
mirror of https://github.com/wxWidgets/Phoenix.git synced 2025-12-15 17:20:07 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

Docs: update postprocessing to account for sphinx v8

Browse Source
This commit is contained in:
neofelis2X
2025-01-23 02:51:35 +01:00
parent 7953f5bba8
commit 2a2179f396
2 changed files with 40 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
sphinxtools/constants.py
View File

@@ -169,15 +169,17 @@ RE_KEEP_SPACES = re.compile(r'(\s+)')
# A list of things used in the post-processing of the HTML files generated by Sphinx
# This list is used only to insert a HTML horizontal line (<hr>) after each method/function
# description
HTML_REPLACE = ['module', 'function', 'method', 'class', 'classmethod', 'staticmethod', 'attribute']
HTML_REPLACE = ['module', 'function', 'py function', 'class', 'py class',
'method', 'py method', 'classmethod', 'staticmethod',
'attribute', 'py attribute']
# Today's date representation for the Sphinx HTML docs
TODAY = datetime.date.today().strftime('%d %B %Y')
# Inheritance diagram external hyperlinks
PYTHON_DOCS = 'http://docs.python.org/library/'
NUMPY_DOCS = 'http://docs.scipy.org/doc/numpy/reference/generated/'
PYTHON_DOCS = 'https://docs.python.org/3/library/'
NUMPY_DOCS = 'https://numpy.org/doc/stable/reference/'
EXTERN_INHERITANCE = {'UserDict.' : PYTHON_DOCS,
'ctypes.' : PYTHON_DOCS,

52
sphinxtools/postprocess.py
View File

@@ -657,22 +657,27 @@ def postProcess(folder, options):
for indx, enum in enumerate(enum_base):
html_file = os.path.split(enum_files[indx])[1]
base = enum.split('.')[-1]
new = '(<a class="reference internal" href="%s" title="%s"><em>%s</em></a>)'%(html_file, base, base)
enum_dict['(<em>%s</em>)'%enum] = new
new = '(<a class="reference internal" href="%s" title="%s"><em>%s</em></a>)' % (html_file, base, base)
enum_dict['(<em>%s</em>)' % enum] = new
for filename in fileNames:
if "genindex" in filename or "modindex" in filename:
continue
methods_done = properties_done = False
methods_done = attr_done = fn_done = False
with textfile_open(filename, "rt") as fid:
orig_text = text = fid.read()
text = text.replace('Overloaded Implementations:', '<strong>Overloaded Implementations:</strong>')
text = text.replace('Overloaded Implementations:',
'<strong>Overloaded Implementations:</strong>')
for item in HTML_REPLACE:
if item != 'class':
text = text.replace('<dl class="%s">'%item, '\n<br><hr />\n<dl class="%s">'%item)
if item in ('class', 'py class'):
continue
text = text.replace('<dl class="%s">' % item,
'<br><hr><dl class="%s">' % item)
newtext = ''
splitted_text = text.splitlines()
@@ -684,19 +689,32 @@ def postProcess(folder, options):
line = line.replace('– <p>', '– ')
line = line.replace('</p>', '')
if line.strip() == '<br><hr />' or line.strip() == '<dd><br><hr />':
next_line = splitted_text[index+1]
stripline = next_line.strip()
if not fn_done and \
line.strip() in ('<br><hr><dl class="function">',
'<br><hr><dl class="py function">'):
# replace the <hr> with a new headline for the first method or first property
if (stripline == '<dl class="staticmethod">' or stripline == '<dl class="method">' \
or stripline == '<dl class="classmethod">') and not methods_done:
line = '\n<br><h3>Methods<a class="headerlink" href="#methods" title="Permalink to this headline">¶</a></h3>\n'
methods_done = True
line = line[8:]
fn_done = True
elif stripline == '<dl class="attribute">' and not properties_done:
line = '\n<br><h3>Properties<a class="headerlink" href="#properties" title="Permalink to this headline">¶</a></h3>\n'
properties_done = True
if not methods_done and \
line.strip() in ('<br><hr><dl class="method">',
'<br><hr><dl class="py method">',
'<br><hr><dl class="staticmethod">',
'<br><hr><dl class="classmethod">'):
line = '\n<br>\n<h3>Methods<a class="headerlink" \
href="#methods" title="Permalink to this \
headline">¶</a></h3>\n' + line[8:]
methods_done = True
if not attr_done and \
line.strip() in ('<br><hr><dl class="attribute">',
'<br><hr><dl class="py attribute">'):
line = '\n<br>\n<h3>Properties<a class="headerlink" \
href="#properties" title="Permalink to this \
headline">¶</a></h3>\n' + line[8:]
attr_done = True
newtext += line + '\n'