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

Fix incompatibility with ModuleDoc(). #1

Open
wants to merge 1 commit into
base: hw_cdc_eptri
Choose a base branch
from

Conversation

fidergo-stephane-gourichon

Without this call to ModuleDoc.__init__(self), generate_docs() fails.
Fix provided by zyp on #litex.

Traceback (most recent call last):
File "mydesign.py", line 299, in
main()
File "mydesign.py", line 292, in main
generate_docs(soc, "build/"+target+"/documentation")
File ".../litex/litex/litex/soc/doc/init.py", line 98, in generate_docs
documented_region = DocumentedCSRRegion(
File ".../litex/litex/litex/soc/doc/csr.py", line 80, in init
docs = module.get_module_documentation()
File ".../litex/litex/litex/soc/integration/doc.py", line 141, in gatherer
return sorted(r, key=lambda x: x.duid)
File ".../litex/litex/litex/soc/integration/doc.py", line 141, in
return sorted(r, key=lambda x: x.duid)
File ".../litex/migen/migen/fhdl/module.py", line 136, in getattr
raise AttributeError("'"+self.class.name+"' object has no attribute '"+name+"'")
AttributeError: 'CDCUsbPHY' object has no attribute 'duid'

Traceback (most recent call last):
  File "mydesign.py", line 299, in <module>
    main()
  File "mydesign.py", line 292, in main
    generate_docs(soc, "build/"+target+"/documentation")
  File ".../litex/litex/litex/soc/doc/__init__.py", line 98, in generate_docs
    documented_region = DocumentedCSRRegion(
  File ".../litex/litex/litex/soc/doc/csr.py", line 80, in __init__
    docs = module.get_module_documentation()
  File ".../litex/litex/litex/soc/integration/doc.py", line 141, in gatherer
    return sorted(r, key=lambda x: x.duid)
  File ".../litex/litex/litex/soc/integration/doc.py", line 141, in <lambda>
    return sorted(r, key=lambda x: x.duid)
  File ".../litex/migen/migen/fhdl/module.py", line 136, in __getattr__
    raise AttributeError("'"+self.__class__.__name__+"' object has no attribute '"+name+"'")
AttributeError: 'CDCUsbPHY' object has no attribute 'duid'
@fidergo-stephane-gourichon
Copy link
Author

This fixed the affected documentation, thanks zyp for the suggestion: enjoy-digital/litex#668

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
1 participant