1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824
|
# -*- coding: utf-8 -*-
#---------------------------------------------------------------------------
# Name: sphinxtools/postprocess.py
# Author: Andrea Gavana
#
# Created: 30-Nov-2010
# Copyright: (c) 2010-2020 by Total Control Software
# License: wxWindows License
#---------------------------------------------------------------------------
# Standard library imports
import sys
import os
import re
import glob
import random
# Phoenix-specific imports
from buildtools.config import Config, writeIfChanged, newer, textfile_open, runcmd
from etgtools.item_module_map import ItemModuleMap
from . import templates
from .utilities import wx2Sphinx, PickleFile
from .constants import HTML_REPLACE, TODAY, SPHINXROOT, SECTIONS_EXCLUDE
from .constants import CONSTANT_INSTANCES, WIDGETS_IMAGES_ROOT, SPHINX_IMAGES_ROOT
from .constants import DOCSTRING_KEY
# ----------------------------------------------------------------------- #
def makeHeadings():
"""
Generates the "headings.inc" file containing the substitution reference
for the small icons used in the Sphinx titles, sub-titles and so on.
The small icons are stored into the ``SPHINX_IMAGES_ROOT`` folder.
.. note:: The "headings.inc" file is created in the ``SPHINXROOT`` folder
(see `sphinxtools/constants.py`).
"""
images = glob.glob(SPHINX_IMAGES_ROOT + '/*.png')
images.sort()
heading_file = os.path.join(SPHINXROOT, 'headings.inc')
text = ""
for img in images:
name = os.path.split(os.path.splitext(img)[0])[1]
rel_path_index = img.find('_static')
rel_path = img[rel_path_index:]
width = 32
if 'overload' in name or 'contributed' in name:
width = 16
rel_path = os.path.normpath(rel_path).replace('\\', '/')
text += templates.TEMPLATE_HEADINGS % (name, rel_path, width)
# Add custom roles
text += "\n.. role:: html(raw)\n :format: html\n\n"
writeIfChanged(heading_file, text)
# ----------------------------------------------------------------------- #
def genIndexes(sphinxDir):
"""
This is the main function called after the `etg` process has finished.
It calls other functions to generate the standalone functions page, the
main class index and some clean-up/maintenance of the generated ReST
files.
"""
print("Generating indexes...")
pklfiles = sorted(glob.glob(sphinxDir + '/*.pkl'))
for file in pklfiles:
if file.endswith('functions.pkl'):
reformatFunctions(file)
elif 'moduleindex' in file:
makeModuleIndex(sphinxDir, file)
buildEnumsAndMethods(sphinxDir)
# ----------------------------------------------------------------------- #
def buildEnumsAndMethods(sphinxDir):
"""
This function does some clean-up/refactoring of the generated ReST files by:
1. Removing the `:meth:` reference to Enums, as they are not methods, and replacing
it with the `:ref:` role. This information is unfortunately not known when the
main `etgtools/sphinx_generator.py` runs.
2. Removing the "Perl note" stuff from the text (and we should clean up the
wxWidgets docs at the source to remove the wxPython notes as well).
3. Substituting the `:ref:` role for unreferenced classes (these may be classes yet
to be ported to Phoenix or C++-specific classes which will never be ported to
Phoenix) with simple backticks.
4. Some cleanup.
"""
pf = PickleFile(os.path.join(sphinxDir, 'class_summary.pkl'))
class_summary = pf.read()
unreferenced_classes = {}
textfiles = sorted(glob.glob(sphinxDir + '/*.txt'))
enum_files = sorted(glob.glob(sphinxDir + '/*.enumeration.txt'))
enum_base = [os.path.split(os.path.splitext(enum)[0])[1] for enum in enum_files]
enum_base = [enum.replace('.enumeration', '') for enum in enum_base]
enum_dict = {}
for enum in enum_base:
enum_dict[':meth:`%s`'%enum] = ':ref:`%s`'%enum
for input in textfiles:
with textfile_open(input, 'rt') as fid:
orig_text = text = fid.read()
for old, new in list(enum_dict.items()):
text = text.replace(old, new)
widget_name = os.path.split(os.path.splitext(input)[0])[1]
if widget_name in SECTIONS_EXCLUDE:
start, end = SECTIONS_EXCLUDE[widget_name]
if start in text and end in text:
lindex = text.index(start)
rindex = text.index(end)
text = text[0:lindex] + text[rindex:]
# Replace the "Perl Note" stuff, we don't need it
newtext = ''
for line in text.splitlines():
if 'perl note' in line.lower():
continue
newtext += line + '\n'
text = newtext
text = findInherited(input, class_summary, enum_base, text)
text, unreferenced_classes = removeUnreferenced(input, class_summary, enum_base, unreferenced_classes, text)
text = text.replace('non-NULL', 'not ``None``')
text = text.replace(',,', ',').replace(', ,', ',')
# Replacements for ScrolledWindow and ScrolledCanvas...
text = text.replace('<wxWindow>', 'Window')
text = text.replace('<wxPanel>', 'Panel')
# Replacement for wx.grid stuff
text = text.replace(' int *,', ' int,')
if 'DocstringsGuidelines' not in input:
# Leave the DocstringsGuidelines.txt file alone on these ones
text = text.replace(':note:', '.. note::')
text = text.replace(':see:', '.. seealso::')
text = text.replace('`String`&', 'string')
text = text.replace('See also\n', '.. seealso:: ')
# Avoid Sphinx warnings on wx.TreeCtrl
text = text.replace('**( `', '** ( `')
# Replace EmptyString stuff
for item in ['wx.EmptyString', 'EmptyString']:
text = text.replace(item, '""')
# Replace ArrayXXX stuff...
for cpp in ['ArrayString()', 'ArrayInt()', 'ArrayDouble()']:
text = text.replace(cpp, '[]')
for cpp, py in [('`ArrayString`', 'list of strings'),
('`ArrayInt`', 'list of integers'),
('`ArrayDouble`', 'list of floats')]:
text = text.replace(cpp, py)
# Remove lines with "Event macros" in them...
text = text.replace('Event macros:', '')
text = tooltipsOnInheritance(text, class_summary)
text = addSpacesToLinks(text)
if text != orig_text:
with textfile_open(input, 'wt') as fid:
fid.write(text)
if not unreferenced_classes:
return
warn = '\n\nWARNING: there are %d instances of referenced classes/enums, via the `:ref:` role, which\n' \
'are not in the list of available classes (these may be classes yet to be ported to Phoenix\n' \
'or C++-specific classes which will never be ported to Phoenix).\n\n' \
'*sphinxgenerator* has replaced the `:ref:` role for them with simple backticks, i.e.:\n\n' \
' :ref:`MissingClass` ==> `MissingClass`\n\n' \
'to avoid warning from Sphinx and Docutils, and saved a list of their occurrences into\n' \
'the text file "unreferenced_classes.inc" together with the ReST file names where they\n' \
'appear.\n\n'
with textfile_open(os.path.join(SPHINXROOT, 'unreferenced_classes.inc'), 'wt') as fid:
fid.write('\n')
fid.write('='*50 + ' ' + '='*50 + '\n')
fid.write('%-50s %-50s\n'%('Reference', 'File Name(s)'))
fid.write('='*50 + ' ' + '='*50 + '\n')
for key in sorted(unreferenced_classes):
fid.write('%-50s %-50s\n'%(key, ', '.join(unreferenced_classes[key])))
fid.write('='*50 + ' ' + '='*50 + '\n')
print((warn%(len(unreferenced_classes))))
# ----------------------------------------------------------------------- #
def findInherited(input, class_summary, enum_base, text):
# Malformed inter-links
regex = re.findall(r'\S:meth:\S+', text)
for regs in regex:
newreg = regs[0] + ' ' + regs[1:]
text = text.replace(regs, newreg)
regex = re.findall(r':meth:\S+', text)
for regs in regex:
hasdot = '.' in regs
hastilde = '~' in regs
if regs.count('`') < 2:
continue
full_name = regs[regs.index('`')+1:regs.rindex('`')]
full_name = full_name.replace('~', '')
curr_class = dummy = os.path.split(os.path.splitext(input)[0])[1]
if hasdot:
newstr = full_name.split('.')
curr_class, meth_name = '.'.join(newstr[0:-1]), newstr[-1]
else:
meth_name = full_name
if meth_name == curr_class:
newtext = ':ref:`%s`'%meth_name
text = text.replace(regs, newtext, 1)
continue
if meth_name in CONSTANT_INSTANCES:
text = text.replace(regs, '``%s``'%meth_name, 1)
continue
if curr_class not in class_summary:
continue
methods, bases, short_description = class_summary[curr_class]
methods = [m.split('.')[-1] for m in methods]
if meth_name in methods:
continue
if meth_name in class_summary:
newtext = ':ref:`%s`'%meth_name
text = text.replace(regs, newtext, 1)
continue
newstr = ''
for cls in bases:
if cls not in class_summary:
continue
submethods, subbases, subshort = class_summary[cls]
short_submethods = [m.split('.')[-1] for m in submethods]
if meth_name in short_submethods:
if not hasdot:
newstr = ':meth:`~%s.%s`'%(cls, meth_name)
elif not hastilde:
newstr = ':meth:`%s.%s <%s.%s>`'%(curr_class, meth_name, cls, meth_name)
elif hasdot:
newstr = ':meth:`~%s.%s`'%(cls, meth_name)
else:
newstr = ':meth:`%s.%s <%s.%s>`'%(curr_class, meth_name, cls, meth_name)
break
if newstr:
text = text.replace(regs, newstr, 1)
return text
# ----------------------------------------------------------------------- #
def removeUnreferenced(input, class_summary, enum_base, unreferenced_classes, text):
regex = re.findall(':ref:`(.*?)`', text)
for reg in regex:
if reg in class_summary or reg in enum_base:
continue
if ' ' in reg or '-' in reg:
# Leave the items with spaces/dash alone, as they are
# Overview pages
continue
if '.' in reg:
# Sometimes in wxWidgets the enums and structures are reported as
# Class.Enum/Class.Structure, while we only have links to Enum and Structures
possible_enum = reg.split('.')[1]
if possible_enum in enum_base or possible_enum in class_summary:
text = text.replace(':ref:`%s`'%reg, ':ref:`%s`'%possible_enum, 1)
continue
if reg not in unreferenced_classes:
unreferenced_classes[reg] = []
split = os.path.split(input)[1]
if split not in unreferenced_classes[reg]:
unreferenced_classes[reg].append(split)
text = text.replace(':ref:`%s`'%reg, '`%s` '%reg, 1)
return text, unreferenced_classes
# ----------------------------------------------------------------------- #
def addSpacesToLinks(text):
regex = re.findall(r'\w:ref:`(.*?)`', text)
for reg in regex:
text = text.replace(':ref:`%s`'%reg, ' :ref:`%s`'%reg)
return text
# ----------------------------------------------------------------------- #
def reformatFunctions(file):
text_file = os.path.splitext(file)[0] + '.txt'
local_file = os.path.split(file)[1]
if not newer(file, text_file):
return
pf = PickleFile(file)
functions = pf.read()
if local_file.count('.') == 2:
# Core functions
label = 'wx'
else:
label = '.'.join(local_file.split('.')[0:2])
names = sorted([name.lower() for name in functions])
text = templates.TEMPLATE_FUNCTION_SUMMARY % (label, label)
letters = []
for fun in names:
upper = fun[0].upper()
if upper not in letters:
letters.append(upper)
text += ' | '.join([':ref:`%s <%s %s>`'%(letter, label, letter) for letter in letters])
text += '\n\n\n'
names = sorted(functions, key=str.lower)
imm = ItemModuleMap()
for letter in letters:
text += '.. _%s %s:\n\n%s\n^\n\n'%(label, letter, letter)
for fun in names:
if fun[0].upper() != letter:
continue
text += '* :func:`%s`\n' % imm.get_fullname(fun)
text += '\n\n'
text += 'Functions\n=============\n\n'
for fun in names:
text += functions[fun] + '\n'
writeIfChanged(text_file, text)
# ----------------------------------------------------------------------- #
def makeModuleIndex(sphinxDir, file):
text_file = os.path.splitext(file)[0] + '.txt'
local_file = os.path.split(file)[1]
if not newer(file, text_file):
return
pf = PickleFile(file)
classes = pf.read()
module_docstring = classes.get(DOCSTRING_KEY)
if module_docstring is not None:
del classes[DOCSTRING_KEY]
if local_file.startswith('wx.1'):
# Core functions
label = 'wx'
module = 'wx'
enumDots = 2
# Take care to get only files starting with "wx.UpperName", not
# "wx.lower.UpperName". This is so we don't put all the enums in the
# submodules in the core wx module too.
# TODO: This may not work on case-insensitive file systems, check it.
enum_files = sorted(glob.glob(sphinxDir + '/wx.[A-Z]*.enumeration.txt'))
else:
label = '.'.join(local_file.split('.')[0:2])
module = label
enumDots = 3
enum_files = sorted(glob.glob(sphinxDir + '/%s*.enumeration.txt' % module))
enum_base = [os.path.split(os.path.splitext(enum)[0])[1] for enum in enum_files]
imm = ItemModuleMap()
names = sorted(classes, key=lambda n: imm.get_fullname(n))
# Workaround to sort names in a case-insensitive way
lower_to_name = {name.lower(): name for name in names}
text = ''
if module:
text += '\n\n.. module:: %s\n\n' % module
text += templates.TEMPLATE_CLASS_INDEX % (label, module_docstring)
text += 80*'=' + ' ' + 80*'=' + '\n'
text += '%-80s **Short Description**\n' % '**Class**'
text += 80*'=' + ' ' + 80*'=' + '\n'
lower_names = sorted(lower_to_name)
for lower in lower_names:
cls = lower_to_name[lower]
out = classes[cls]
if '=====' in out:
out = ''
text += '%-80s %s\n' % (':ref:`~%s`' % wx2Sphinx(cls)[1], out)
text += 80*'=' + ' ' + 80*'=' + '\n\n'
contents = []
for lower in lower_names:
cls = lower_to_name[lower]
contents.append(wx2Sphinx(cls)[1])
for enum in enum_base:
if enum.count('.') == enumDots:
contents.append(enum)
contents.sort()
# Are there functions for this module too?
functionsFile = os.path.join(sphinxDir, module + '.functions.pkl')
if os.path.exists(functionsFile):
pf = PickleFile(functionsFile)
functions = sorted(pf.read(), key=lambda n: imm.get_fullname(n))
pf = PickleFile(os.path.join(SPHINXROOT, 'function_summary.pkl'))
function_summaries = pf.read()
text += templates.TEMPLATE_MODULE_FUNCTION_SUMMARY
text += 80*'=' + ' ' + 80*'=' + '\n'
text += '%-80s **Short Description**\n' % '**Function**'
text += 80*'=' + ' ' + 80*'=' + '\n'
for func_name in functions:
fullname = imm.get_fullname(func_name)
doc = function_summaries.get(fullname, '')
text += '%-80s %s\n' % (':func:`~%s`' % fullname, doc)
text += 80 * '=' + ' ' + 80 * '=' + '\n\n'
contents.append(module + '.functions')
toctree = ''
for item in contents:
toctree += ' %s\n' % item
text += templates.TEMPLATE_TOCTREE % toctree
writeIfChanged(text_file, text)
# ----------------------------------------------------------------------- #
def genGallery():
print("Generating gallery...")
link = '<div class="gallery_class">'
link_template = """\
<table><caption align="bottom"><a href="%s"><b>%s</b></a></caption>
<tr>
<td><a href="%s"><img src="_static/images/widgets/fullsize/%s/%s" border="20" alt="%s"/></a>
</td>
</tr>
</table>
"""
image_folder = WIDGETS_IMAGES_ROOT
platforms = ['wxmsw', 'wxgtk', 'wxmac']
image_files = {}
pwd = os.getcwd()
for folder in platforms:
plat_folder = os.path.join(image_folder, folder)
os.chdir(plat_folder)
image_files[folder] = sorted(glob.glob('*.png'))
os.chdir(pwd)
txt_files = sorted(glob.glob(SPHINXROOT + '/*.txt'))
html_files = {}
for text in txt_files:
simple = os.path.split(os.path.splitext(text)[0])[1]
possible = simple.lower()
html_files[possible + '.png'] = simple + '.html'
keys = sorted(html_files)
text = ''
for key in keys:
possible_png = key
html = html_files[possible_png]
rand_list = list(range(3))
random.shuffle(rand_list)
for plat_index in rand_list:
platform = platforms[plat_index]
plat_images = image_files[platform]
if possible_png in plat_images:
text += link_template % (html, os.path.splitext(html)[0], html, platform, possible_png, os.path.splitext(html)[0])
text += '\n'
break
gallery = os.path.join(SPHINXROOT, '_templates', 'gallery.html')
writeIfChanged(gallery, templates.TEMPLATE_GALLERY % text)
# ----------------------------------------------------------------------- #
def addPrettyTable(text):
""" Unused at the moment. """
newtext = """<br>
<table border="1" class="docutils"> """
newtext2 = """<br>
<table border="1" class="last docutils"> """
text = text.replace('<table border="1" class="docutils">', newtext)
text = text.replace('<table border="1" class="last docutils">', newtext2)
othertext = """class="pretty-table">"""
text = text.replace('class="docutils">', othertext)
text = text.replace('class="last docutils">', othertext)
return text
# ----------------------------------------------------------------------- #
def classToFile(line):
if '–' not in line:
return line
if 'href' in line and '<li>' in line and '(' in line and ')' in line:
indx1 = line.index('href=')
if 'title=' in line:
indx2 = line.rindex('title=')
paramdesc = line[indx1+6:indx2-2]
if '.html#' in paramdesc:
newparamdesc = paramdesc[:]
lower = paramdesc.index('#') + 1
letter = paramdesc[lower]
if letter.isupper():
newparamdesc = newparamdesc[0:lower] + letter.lower() + newparamdesc[lower+1:]
newparamdesc = newparamdesc.replace(letter, letter.lower(), 1)
line = line.replace(paramdesc, newparamdesc)
return line
# ----------------------------------------------------------------------- #
def addJavaScript(text):
jsCode = """\
<script>
$(".codeexpander").collapse({head: "p", group: "div"},
{show: function(){
this.animate({
opacity: 'toggle',
height: 'toggle'
}, 300);
},
hide : function() {
this.animate({
opacity: 'toggle',
height: 'toggle'
}, 300);
}
});
</script>
"""
index = text.rfind('</body>')
newtext = text[0:index] + jsCode + text[index:]
return newtext
# ----------------------------------------------------------------------- #
def postProcess(folder, options):
fileNames = sorted(glob.glob(folder + "/*.html"))
enum_files = sorted(glob.glob(folder + '/*.enumeration.html'))
enum_base = [os.path.split(os.path.splitext(enum)[0])[1] for enum in enum_files]
enum_base = [enum.replace('.enumeration', '') for enum in enum_base]
enum_dict = {}
# ENUMS
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
for filename in fileNames:
if "genindex" in filename or "modindex" in filename:
continue
methods_done = attr_done = fn_done = False
with textfile_open(filename, "rt") as fid:
orig_text = text = fid.read()
for item in HTML_REPLACE:
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()
len_split = len(splitted_text)
for index, line in enumerate(splitted_text):
if index < len_split - 1:
if '– <p>' in line and '</p>' in line:
line = line.replace('– <p>', '– ')
line = line.replace('</p>', '')
if not fn_done and \
line.strip() in ('<br><hr><dl class="function">',
'<br><hr><dl class="py function">'):
line = line[8:]
fn_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'
for old, new in list(enum_dict.items()):
newtext = newtext.replace(old, new)
newtext = addJavaScript(newtext)
basename = os.path.split(filename)[1]
if basename == 'index.html':
newtext = changeWelcomeText(newtext, options)
else:
newtext = removeHeaderImage(newtext, options)
if '1moduleindex' in basename:
newtext = tweakModuleIndex(newtext)
if orig_text != newtext:
with textfile_open(filename, "wt") as fid:
fid.write(newtext)
# ----------------------------------------------------------------------- #
def changeWelcomeText(text, options):
cfg = Config(noWxConfig=True)
if options.release:
welcomeText = """
Welcome! This is the API reference documentation for the <b>{version}
release</b> of wxPython Phoenix, built on {today}.
""".format(version=cfg.VERSION, today=TODAY)
else:
revhash = runcmd('git rev-parse --short HEAD', getOutput=True, echoCmd=False)
welcomeText = """
Welcome! This is the API documentation for the wxPython Phoenix
<b>pre-release snapshot</b> build <b>{version}</b>, last updated {today}
from git revision:
<a href="https://github.com/wxWidgets/Phoenix/commit/{revhash}">{revhash}</a>.
""".format(version=cfg.VERSION, today=TODAY, revhash=revhash)
text = text.replace('!WELCOME!', welcomeText)
return text
def removeHeaderImage(text, options):
from bs4 import BeautifulSoup
soup = BeautifulSoup(text, 'html.parser')
tag = soup.find('div', 'headerimage')
if tag:
tag.extract()
text = str(soup)
return text
def tweakModuleIndex(text):
from bs4 import BeautifulSoup
soup = BeautifulSoup(text, 'html.parser')
for tag in soup.findAll('a'):
# Chop off the #anchor if it is identical to the basname of the doc
href = tag['href'].split('.html#')
if len(href) == 2 and href[0] == href[1]:
tag['href'] = href[0] + '.html'
return str(soup)
def tooltipsOnInheritance(text, class_summary):
graphviz = re.findall(r'<p class="graphviz">(.*?)</p>', text, re.DOTALL)
if not graphviz:
return text
graphviz = graphviz[0]
original = graphviz[:]
html_links = re.findall('href="(.*?)"', graphviz)
titles = re.findall('title="(.*?)"', graphviz)
ReST = ['ref', 'class', 'mod', 'meth', 'attr']
for link, title in zip(html_links, titles):
if 'http://' in link:
# No tooltip for this one
continue
class_name = os.path.splitext(link)[0]
if class_name not in class_summary:
continue
methods, bases, short_description = class_summary[class_name]
if not short_description.strip():
# Leave the default tooltip
continue
replace_string = 'title="%s"'%title
description = short_description.replace('\n', ' ').lstrip()
for item in ReST:
description = re.sub(':%s:`~(.*?)`'%item, r'\1', description)
description = re.sub(':%s:`(.*?)`'%item, r'\1', description)
description = description.replace('"', "'")
graphviz = graphviz.replace(replace_string, 'title="%s"'%description)
text = text.replace(original, graphviz)
return text
|