Collect information necessary specifically for a module's doc page. Mainly this is information about the members of the module. Args: parser_config: An instance of ParserConfig.
(self, parser_config)
| 1406 | return meta_data.build_html() |
| 1407 | |
| 1408 | def collect_docs_for_module(self, parser_config): |
| 1409 | """Collect information necessary specifically for a module's doc page. |
| 1410 | |
| 1411 | Mainly this is information about the members of the module. |
| 1412 | |
| 1413 | Args: |
| 1414 | parser_config: An instance of ParserConfig. |
| 1415 | """ |
| 1416 | relative_path = os.path.relpath( |
| 1417 | path='.', |
| 1418 | start=os.path.dirname(documentation_path(self.full_name)) or '.') |
| 1419 | |
| 1420 | member_names = parser_config.tree.get(self.full_name, []) |
| 1421 | for name in member_names: |
| 1422 | |
| 1423 | if name in ['__builtins__', '__doc__', '__file__', |
| 1424 | '__name__', '__path__', '__package__', |
| 1425 | '__cached__', '__loader__', '__spec__']: |
| 1426 | continue |
| 1427 | |
| 1428 | member_full_name = self.full_name + '.' + name if self.full_name else name |
| 1429 | member = parser_config.py_name_to_object(member_full_name) |
| 1430 | |
| 1431 | member_doc = _parse_md_docstring(member, relative_path, |
| 1432 | parser_config.reference_resolver) |
| 1433 | |
| 1434 | url = parser_config.reference_resolver.reference_to_url( |
| 1435 | member_full_name, relative_path) |
| 1436 | |
| 1437 | if tf_inspect.ismodule(member): |
| 1438 | self._add_module(name, member_full_name, member, member_doc, url) |
| 1439 | |
| 1440 | elif tf_inspect.isclass(member): |
| 1441 | self._add_class(name, member_full_name, member, member_doc, url) |
| 1442 | |
| 1443 | elif tf_inspect.isfunction(member): |
| 1444 | self._add_function(name, member_full_name, member, member_doc, url) |
| 1445 | |
| 1446 | else: |
| 1447 | self._add_other_member(name, member_full_name, member, member_doc) |
| 1448 | |
| 1449 | |
| 1450 | class ParserConfig(object): |
no test coverage detected