summaryrefslogtreecommitdiff
path: root/pydoc.py
diff options
context:
space:
mode:
Diffstat (limited to 'pydoc.py')
-rwxr-xr-xpydoc.py12
1 files changed, 9 insertions, 3 deletions
diff --git a/pydoc.py b/pydoc.py
index 0b124f7..f01c870 100755
--- a/pydoc.py
+++ b/pydoc.py
@@ -90,6 +90,7 @@ def is_documented_in_inventory(ob: model.Documentable, inventory: Inventory) ->
# TODO: it's not ideal that we default to True, ideally we could cover all kinds
return True
+
def inventory_members(inventory: Inventory):
for x in inventory['py:class']:
yield x
@@ -124,6 +125,7 @@ class SphinxAwareSystem(model.System):
return super().privacyClass(ob)
+
def system_for_sphinx_inventory(inventory_url: str):
inventory_url = packages[package_name]['sphinx_inventory_url']
url_base = inventory_url.rsplit('/', maxsplit=1)[0]
@@ -140,7 +142,9 @@ def system_for_sphinx_inventory(inventory_url: str):
f.write(inventory_bytes)
if 'py:module' not in inventory:
- print(f"[warning] sphinx inventory for {package_name} does not contain py:module, we're ignoring the inventory")
+ print(
+ f"[warning] sphinx inventory for {package_name} does not contain py:module, we're ignoring the inventory"
+ )
# TODO: display warning in HTML
return None
@@ -148,6 +152,7 @@ def system_for_sphinx_inventory(inventory_url: str):
system.options.docformat = docformat
return system
+
if __name__ == '__main__':
sources = Path('sources')
sources.mkdir(exist_ok=True)
@@ -268,8 +273,9 @@ if __name__ == '__main__':
system = None
if 'sphinx_inventory_url' in packages[package_name]:
- system = system_for_sphinx_inventory(packages[package_name]['sphinx_inventory_url'])
-
+ system = system_for_sphinx_inventory(
+ packages[package_name]['sphinx_inventory_url']
+ )
pydoctor.driver.main(
# fmt: off