Browse Source

docs: fix the inheritance diagrams in the apidocs

merge-requests/2340/merge
Thomas Nagy 3 months ago
parent
commit
f421d09d6a
  1. 8
      docs/sphinx/conf.py
  2. 2
      waflib/Context.py
  3. 1
      waflib/Tools/ccroot.py
  4. 1
      waflib/Tools/tex.py

8
docs/sphinx/conf.py

@ -26,6 +26,9 @@ html_theme_options = {
"body_max_width": "none",
}
inheritance_graph_attrs = dict(rankdir="LR", size='""', fontsize=14, ratio='compress')
# monkey patch a few waf classes for documentation purposes!
#-----------------------------------------------------------
@ -175,8 +178,9 @@ Configure.ConfigurationContext.__doc__ = """
ctx.myhelper()
"""
from waflib.Tools import asm
del asm.__dict__['link_task']
del asm.__dict__['stlink_task']
# Import all tools and build tool->feature map
tool_to_features = {}

2
waflib/Context.py

@ -144,7 +144,7 @@ class Context(ctx):
:type fun: string
.. inheritance-diagram:: waflib.Context.Context waflib.Build.BuildContext waflib.Build.InstallContext waflib.Build.UninstallContext waflib.Build.StepContext waflib.Build.ListContext waflib.Configure.ConfigurationContext waflib.Scripting.Dist waflib.Scripting.DistCheck waflib.Build.CleanContext
:top-classes: waflib.Context.Context
"""
errors = Errors

1
waflib/Tools/ccroot.py

@ -128,6 +128,7 @@ class link_task(Task.Task):
Base class for all link tasks. A task generator is supposed to have at most one link task bound in the attribute *link_task*. See :py:func:`waflib.Tools.ccroot.apply_link`.
.. inheritance-diagram:: waflib.Tools.ccroot.stlink_task waflib.Tools.c.cprogram waflib.Tools.c.cshlib waflib.Tools.cxx.cxxstlib waflib.Tools.cxx.cxxprogram waflib.Tools.cxx.cxxshlib waflib.Tools.d.dprogram waflib.Tools.d.dshlib waflib.Tools.d.dstlib waflib.Tools.ccroot.fake_shlib waflib.Tools.ccroot.fake_stlib waflib.Tools.asm.asmprogram waflib.Tools.asm.asmshlib waflib.Tools.asm.asmstlib
:top-classes: waflib.Tools.ccroot.link_task
"""
color = 'YELLOW'

1
waflib/Tools/tex.py

@ -90,6 +90,7 @@ class tex(Task.Task):
Compiles a tex/latex file.
.. inheritance-diagram:: waflib.Tools.tex.latex waflib.Tools.tex.xelatex waflib.Tools.tex.pdflatex
:top-classes: waflib.Tools.tex.tex
"""
bibtex_fun, _ = Task.compile_fun('${BIBTEX} ${BIBTEXFLAGS} ${SRCFILE}', shell=False)

Loading…
Cancel
Save