Note a python module for cross reference. .. versionadded:: 2.1
(
self, name: str, node_id: str, synopsis: str, platform: str, deprecated: bool
)
| 817 | return self.data.setdefault('modules', {}) # modname -> ModuleEntry |
| 818 | |
| 819 | def note_module( |
| 820 | self, name: str, node_id: str, synopsis: str, platform: str, deprecated: bool |
| 821 | ) -> None: |
| 822 | """Note a python module for cross reference. |
| 823 | |
| 824 | .. versionadded:: 2.1 |
| 825 | """ |
| 826 | self.modules[name] = ModuleEntry( |
| 827 | docname=self.env.current_document.docname, |
| 828 | node_id=node_id, |
| 829 | synopsis=synopsis, |
| 830 | platform=platform, |
| 831 | deprecated=deprecated, |
| 832 | ) |
| 833 | |
| 834 | def clear_doc(self, docname: str) -> None: |
| 835 | to_remove = [ |