Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[External Tracking] Sphinx doesn't generate documentation for classes derived from metaclasses with type hints #10

Open
Paebbels opened this issue Oct 3, 2021 · 0 comments
Labels
Bug Something isn't working Documentation Improvements or additions to documentation

Comments

@Paebbels
Copy link
Member

Paebbels commented Oct 3, 2021

Sphinx generates error messages for classes derived from a common class with a meta-class other then type.

WARNING: error while formatting signature for pyEDAA.ProjectModel.File: Handler <function record_typehints at 0x000001FF8148CEE0> for event 'autodoc-process-signature' threw an exception (exception: '_partialmethod')
WARNING: error while formatting signature for pyEDAA.ProjectModel.TextFile: Handler <function record_typehints at 0x000001FF8148CEE0> for event 'autodoc-process-signature' threw an exception (exception: '_partialmethod')
WARNING: error while formatting signature for pyEDAA.ProjectModel.LogFile: Handler <function record_typehints at 0x000001FF8148CEE0> for event 'autodoc-process-signature' threw an exception (exception: '_partialmethod')
WARNING: error while formatting signature for pyEDAA.ProjectModel.XMLFile: Handler <function record_typehints at 0x000001FF8148CEE0> for event 'autodoc-process-signature' threw an exception (exception: '_partialmethod')
WARNING: error while formatting signature for pyEDAA.ProjectModel.SourceFile: Handler <function record_typehints at 0x000001FF8148CEE0> for event 'autodoc-process-signature' threw an exception (exception: '_partialmethod')
WARNING: error while formatting signature for pyEDAA.ProjectModel.HDLSourceFile: Handler <function record_typehints at 0x000001FF8148CEE0> for event 'autodoc-process-signature' threw an exception (exception: '_partialmethod')
WARNING: error while formatting signature for pyEDAA.ProjectModel.NetlistFile: Handler <function record_typehints at 0x000001FF8148CEE0> for event 'autodoc-process-signature' threw an exception (exception: '_partialmethod')
WARNING: error while formatting signature for pyEDAA.ProjectModel.EDIFNetlistFile: Handler <function record_typehints at 0x000001FF8148CEE0> for event 'autodoc-process-signature' threw an exception (exception: '_partialmethod')
WARNING: error while formatting signature for pyEDAA.ProjectModel.VHDLSourceFile: Handler <function record_typehints at 0x000001FF8148CEE0> for event 'autodoc-process-signature' threw an exception (exception: '_partialmethod')
WARNING: error while formatting signature for pyEDAA.ProjectModel.VerilogSourceFile: Handler <function record_typehints at 0x000001FF8148CEE0> for event 'autodoc-process-signature' threw an exception (exception: '_partialmethod')
WARNING: error while formatting signature for pyEDAA.ProjectModel.SystemVerilogSourceFile: Handler <function record_typehints at 0x000001FF8148CEE0> for event 'autodoc-process-signature' threw an exception (exception: '_partialmethod')
WARNING: error while formatting signature for pyEDAA.ProjectModel.PythonSourceFile: Handler <function record_typehints at 0x000001FF8148CEE0> for event 'autodoc-process-signature' threw an exception (exception: '_partialmethod')
WARNING: error while formatting signature for pyEDAA.ProjectModel.CocotbPythonFile: Handler <function record_typehints at 0x000001FF8148CEE0> for event 'autodoc-process-signature' threw an exception (exception: '_partialmethod')
WARNING: error while formatting signature for pyEDAA.ProjectModel.ConstraintFile: Handler <function record_typehints at 0x000001FF8148CEE0> for event 'autodoc-process-signature' threw an exception (exception: '_partialmethod')
WARNING: error while formatting signature for pyEDAA.ProjectModel.ProjectFile: Handler <function record_typehints at 0x000001FF8148CEE0> for event 'autodoc-process-signature' threw an exception (exception: '_partialmethod')
WARNING: error while formatting signature for pyEDAA.ProjectModel.CSourceFile: Handler <function record_typehints at 0x000001FF8148CEE0> for event 'autodoc-process-signature' threw an exception (exception: '_partialmethod')
WARNING: error while formatting signature for pyEDAA.ProjectModel.CppSourceFile: Handler <function record_typehints at 0x000001FF8148CEE0> for event 'autodoc-process-signature' threw an exception (exception: '_partialmethod')
WARNING: error while formatting signature for pyEDAA.ProjectModel.SettingFile: Handler <function record_typehints at 0x000001FF8148CEE0> for event 'autodoc-process-signature' threw an exception (exception: '_partialmethod')
WARNING: error while formatting signature for pyEDAA.ProjectModel.SimulationAnalysisFile: Handler <function record_typehints at 0x000001FF8148CEE0> for event 'autodoc-process-signature' threw an exception (exception: '_partialmethod')
WARNING: error while formatting signature for pyEDAA.ProjectModel.SimulationElaborationFile: Handler <function record_typehints at 0x000001FF8148CEE0> for event 'autodoc-process-signature' threw an exception (exception: '_partialmethod')
WARNING: error while formatting signature for pyEDAA.ProjectModel.SimulationStartFile: Handler <function record_typehints at 0x000001FF8148CEE0> for event 'autodoc-process-signature' threw an exception (exception: '_partialmethod')
WARNING: error while formatting signature for pyEDAA.ProjectModel.SimulationRunFile: Handler <function record_typehints at 0x000001FF8148CEE0> for event 'autodoc-process-signature' threw an exception (exception: '_partialmethod')
WARNING: error while formatting signature for pyEDAA.ProjectModel.WaveformConfigFile: Handler <function record_typehints at 0x000001FF8148CEE0> for event 'autodoc-process-signature' threw an exception (exception: '_partialmethod')
WARNING: error while formatting signature for pyEDAA.ProjectModel.WaveformDatabaseFile: Handler <function record_typehints at 0x000001FF8148CEE0> for event 'autodoc-process-signature' threw an exception (exception: '_partialmethod')
WARNING: error while formatting signature for pyEDAA.ProjectModel.WaveformExchangeFile: Handler <function record_typehints at 0x000001FF8148CEE0> for event 'autodoc-process-signature' threw an exception (exception: '_partialmethod')
WARNING: error while formatting signature for pyEDAA.ProjectModel.Altera.Quartus.QuartusProjectFile: Handler <function record_typehints at 0x000001FF8148CEE0> for event 'autodoc-process-signature' threw an exception (exception: '_partialmethod')
WARNING: error while formatting signature for pyEDAA.ProjectModel.Altera.Quartus.SDCConstraintFile: Handler <function record_typehints at 0x000001FF8148CEE0> for event 'autodoc-process-signature' threw an exception (exception: '_partialmethod')
WARNING: error while formatting signature for pyEDAA.ProjectModel.Intel.QuartusPrime.QuartusProjectFile: Handler <function record_typehints at 0x000001FF8148CEE0> for event 'autodoc-process-signature' threw an exception (exception: '_partialmethod')
WARNING: error while formatting signature for pyEDAA.ProjectModel.Intel.QuartusPrime.SDCConstraintFile: Handler <function record_typehints at 0x000001FF8148CEE0> for event 'autodoc-process-signature' threw an exception (exception: '_partialmethod')
WARNING: error while formatting signature for pyEDAA.ProjectModel.MentorGraphics.ModelSim.ModelSimProjectFile: Handler <function record_typehints at 0x000001FF8148CEE0> for event 'autodoc-process-signature' threw an exception (exception: '_partialmethod')
WARNING: error while formatting signature for pyEDAA.ProjectModel.MentorGraphics.ModelSim.ModelSimINIFile: Handler <function record_typehints at 0x000001FF8148CEE0> for event 'autodoc-process-signature' threw an exception (exception: '_partialmethod')
WARNING: error while formatting signature for pyEDAA.ProjectModel.MentorGraphics.ModelSim.WaveDoFile: Handler <function record_typehints at 0x000001FF8148CEE0> for event 'autodoc-process-signature' threw an exception (exception: '_partialmethod')
WARNING: error while formatting signature for pyEDAA.ProjectModel.MentorGraphics.QuestaSim.ModelSimProjectFile: Handler <function record_typehints at 0x000001FF8148CEE0> for event 'autodoc-process-signature' threw an exception (exception: '_partialmethod')
WARNING: error while formatting signature for pyEDAA.ProjectModel.MentorGraphics.QuestaSim.ModelSimINIFile: Handler <function record_typehints at 0x000001FF8148CEE0> for event 'autodoc-process-signature' threw an exception (exception: '_partialmethod')
WARNING: error while formatting signature for pyEDAA.ProjectModel.MentorGraphics.QuestaSim.WaveDoFile: Handler <function record_typehints at 0x000001FF8148CEE0> for event 'autodoc-process-signature' threw an exception (exception: '_partialmethod')
WARNING: error while formatting signature for pyEDAA.ProjectModel.Xilinx.ISE.ISEProjectFile: Handler <function record_typehints at 0x000001FF8148CEE0> for event 'autodoc-process-signature' threw an exception (exception: '_partialmethod')
WARNING: error while formatting signature for pyEDAA.ProjectModel.Xilinx.ISE.UCFConstraintFile: Handler <function record_typehints at 0x000001FF8148CEE0> for event 'autodoc-process-signature' threw an exception (exception: '_partialmethod')
WARNING: error while formatting signature for pyEDAA.ProjectModel.Xilinx.Vivado.VivadoProjectFile: Handler <function record_typehints at 0x000001FF8148CEE0> for event 'autodoc-process-signature' threw an exception (exception: '_partialmethod')
WARNING: error while formatting signature for pyEDAA.ProjectModel.Xilinx.Vivado.XDCConstraintFile: Handler <function record_typehints at 0x000001FF8148CEE0> for event 'autodoc-process-signature' threw an exception (exception: '_partialmethod')
WARNING: error while formatting signature for pyEDAA.ProjectModel.Xilinx.Vivado.IPCoreDescriptionFile: Handler <function record_typehints at 0x000001FF8148CEE0> for event 'autodoc-process-signature' threw an exception (exception: '_partialmethod')
WARNING: error while formatting signature for pyEDAA.ProjectModel.Xilinx.Vivado.IPCoreInstantiationFile: Handler <function record_typehints at 0x000001FF8148CEE0> for event 'autodoc-process-signature' threw an exception (exception: '_partialmethod')

Possible reproducer:

class meta(type):
  pass

class myClass(metaclass=meta):
  _value: str

  def __init__(value: str):
    self._value = value

Used Sphinx version and plugins:

  • Sphinx 4.2
  • sphinx_autodoc_typehints 1.12.0
@Paebbels Paebbels added Bug Something isn't working Documentation Improvements or additions to documentation labels Oct 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Something isn't working Documentation Improvements or additions to documentation
Development

No branches or pull requests

1 participant