forked from platypush/platypush
generate_missing_docs 2.0
This commit is contained in:
parent
6e5f746dbe
commit
d5de38975d
GPG key ID:
D90FBA7F76362774
1 changed files with 101 additions and 182 deletions
|
|
@ -1,4 +1,5 @@
|
||||||
import os
|
import os
|
||||||
|
from typing import Iterable, Optional
|
||||||
|
|
||||||
from platypush.backend import Backend
|
from platypush.backend import Backend
|
||||||
from platypush.context import get_plugin
|
from platypush.context import get_plugin
|
||||||
|
|
@ -13,25 +14,11 @@ def _get_inspect_plugin():
|
||||||
|
|
||||||
|
|
||||||
def get_all_plugins():
|
def get_all_plugins():
|
||||||
manifests = {mf.component_name for mf in get_manifests(Plugin)}
|
return sorted([mf.component_name for mf in get_manifests(Plugin)])
|
||||||
return {
|
|
||||||
plugin_name: plugin_info
|
|
||||||
for plugin_name, plugin_info in _get_inspect_plugin()
|
|
||||||
.get_all_plugins()
|
|
||||||
.output.items()
|
|
||||||
if plugin_name in manifests
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
def get_all_backends():
|
def get_all_backends():
|
||||||
manifests = {mf.component_name for mf in get_manifests(Backend)}
|
return sorted([mf.component_name for mf in get_manifests(Backend)])
|
||||||
return {
|
|
||||||
backend_name: backend_info
|
|
||||||
for backend_name, backend_info in _get_inspect_plugin()
|
|
||||||
.get_all_backends()
|
|
||||||
.output.items()
|
|
||||||
if backend_name in manifests
|
|
||||||
}
|
|
||||||
|
|
||||||
|
|
||||||
def get_all_events():
|
def get_all_events():
|
||||||
|
|
@ -42,190 +29,122 @@ def get_all_responses():
|
||||||
return _get_inspect_plugin().get_all_responses().output
|
return _get_inspect_plugin().get_all_responses().output
|
||||||
|
|
||||||
|
|
||||||
# noinspection DuplicatedCode
|
def _generate_components_doc(
|
||||||
|
index_name: str,
|
||||||
|
package_name: str,
|
||||||
|
components: Iterable[str],
|
||||||
|
doc_dir: Optional[str] = None,
|
||||||
|
):
|
||||||
|
if not doc_dir:
|
||||||
|
doc_dir = index_name
|
||||||
|
|
||||||
|
index_file = os.path.join(
|
||||||
|
os.path.dirname(os.path.abspath(__file__)),
|
||||||
|
'docs',
|
||||||
|
'source',
|
||||||
|
f'{index_name}.rst',
|
||||||
|
)
|
||||||
|
docs_dir = os.path.join(
|
||||||
|
os.path.dirname(os.path.abspath(__file__)),
|
||||||
|
'docs',
|
||||||
|
'source',
|
||||||
|
'platypush',
|
||||||
|
doc_dir,
|
||||||
|
)
|
||||||
|
|
||||||
|
for comp in components:
|
||||||
|
comp_file = os.path.join(docs_dir, comp + '.rst')
|
||||||
|
if not os.path.exists(comp_file):
|
||||||
|
comp = f'platypush.{package_name}.{comp}'
|
||||||
|
header = '``' + '.'.join(comp.split('.')[2:]) + '``'
|
||||||
|
divider = '=' * len(header)
|
||||||
|
body = f'\n.. automodule:: {comp}\n :members:\n'
|
||||||
|
out = '\n'.join([header, divider, body])
|
||||||
|
|
||||||
|
with open(comp_file, 'w') as f:
|
||||||
|
f.write(out)
|
||||||
|
|
||||||
|
with open(index_file, 'w') as f:
|
||||||
|
f.write(
|
||||||
|
f'''
|
||||||
|
{index_name.title()}
|
||||||
|
{''.join(['='] * len(index_name))}
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:maxdepth: 1
|
||||||
|
:caption: {index_name.title()}:
|
||||||
|
|
||||||
|
'''
|
||||||
|
)
|
||||||
|
|
||||||
|
for comp in components:
|
||||||
|
f.write(f' platypush/{doc_dir}/{comp}.rst\n')
|
||||||
|
|
||||||
|
_cleanup_removed_components_docs(docs_dir, components)
|
||||||
|
|
||||||
|
|
||||||
|
def _cleanup_removed_components_docs(docs_dir: str, components: Iterable[str]):
|
||||||
|
new_components = set(components)
|
||||||
|
existing_files = {
|
||||||
|
os.path.join(root, file)
|
||||||
|
for root, _, files in os.walk(docs_dir)
|
||||||
|
for file in files
|
||||||
|
if file.endswith('.rst')
|
||||||
|
}
|
||||||
|
|
||||||
|
files_to_remove = {
|
||||||
|
file
|
||||||
|
for file in existing_files
|
||||||
|
if os.path.basename(file).removesuffix('.rst') not in new_components
|
||||||
|
}
|
||||||
|
|
||||||
|
for file in files_to_remove:
|
||||||
|
print(f'Removing unlinked component {file}')
|
||||||
|
os.unlink(file)
|
||||||
|
|
||||||
|
|
||||||
def generate_plugins_doc():
|
def generate_plugins_doc():
|
||||||
plugins_index = os.path.join(
|
_generate_components_doc(
|
||||||
os.path.dirname(os.path.abspath(__file__)), 'docs', 'source', 'plugins.rst'
|
index_name='plugins', package_name='plugins', components=get_all_plugins()
|
||||||
)
|
|
||||||
plugins_dir = os.path.join(
|
|
||||||
os.path.dirname(os.path.abspath(__file__)),
|
|
||||||
'docs',
|
|
||||||
'source',
|
|
||||||
'platypush',
|
|
||||||
'plugins',
|
|
||||||
)
|
|
||||||
all_plugins = sorted(plugin for plugin in get_all_plugins().keys())
|
|
||||||
|
|
||||||
for plugin in all_plugins:
|
|
||||||
plugin_file = os.path.join(plugins_dir, plugin + '.rst')
|
|
||||||
if not os.path.exists(plugin_file):
|
|
||||||
plugin = 'platypush.plugins.' + plugin
|
|
||||||
header = '``{}``'.format('.'.join(plugin.split('.')[2:]))
|
|
||||||
divider = '=' * len(header)
|
|
||||||
body = '\n.. automodule:: {}\n :members:\n'.format(plugin)
|
|
||||||
out = '\n'.join([header, divider, body])
|
|
||||||
|
|
||||||
with open(plugin_file, 'w') as f:
|
|
||||||
f.write(out)
|
|
||||||
|
|
||||||
with open(plugins_index, 'w') as f:
|
|
||||||
f.write(
|
|
||||||
'''
|
|
||||||
Plugins
|
|
||||||
=======
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 1
|
|
||||||
:caption: Plugins:
|
|
||||||
|
|
||||||
'''
|
|
||||||
)
|
)
|
||||||
|
|
||||||
for plugin in all_plugins:
|
|
||||||
f.write(' platypush/plugins/' + plugin + '.rst\n')
|
|
||||||
|
|
||||||
|
|
||||||
# noinspection DuplicatedCode
|
|
||||||
def generate_backends_doc():
|
def generate_backends_doc():
|
||||||
backends_index = os.path.join(
|
_generate_components_doc(
|
||||||
os.path.dirname(os.path.abspath(__file__)), 'docs', 'source', 'backends.rst'
|
index_name='backends',
|
||||||
)
|
package_name='backend',
|
||||||
backends_dir = os.path.join(
|
components=get_all_backends(),
|
||||||
os.path.dirname(os.path.abspath(__file__)),
|
doc_dir='backend',
|
||||||
'docs',
|
|
||||||
'source',
|
|
||||||
'platypush',
|
|
||||||
'backend',
|
|
||||||
)
|
|
||||||
all_backends = sorted(backend for backend in get_all_backends().keys())
|
|
||||||
|
|
||||||
for backend in all_backends:
|
|
||||||
backend_file = os.path.join(backends_dir, backend + '.rst')
|
|
||||||
if not os.path.exists(backend_file):
|
|
||||||
backend = 'platypush.backend.' + backend
|
|
||||||
header = '``{}``'.format('.'.join(backend.split('.')[2:]))
|
|
||||||
divider = '=' * len(header)
|
|
||||||
body = '\n.. automodule:: {}\n :members:\n'.format(backend)
|
|
||||||
out = '\n'.join([header, divider, body])
|
|
||||||
|
|
||||||
with open(backend_file, 'w') as f:
|
|
||||||
f.write(out)
|
|
||||||
|
|
||||||
with open(backends_index, 'w') as f:
|
|
||||||
f.write(
|
|
||||||
'''
|
|
||||||
Backends
|
|
||||||
========
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 1
|
|
||||||
:caption: Backends:
|
|
||||||
|
|
||||||
'''
|
|
||||||
)
|
)
|
||||||
|
|
||||||
for backend in all_backends:
|
|
||||||
f.write(' platypush/backend/' + backend + '.rst\n')
|
|
||||||
|
|
||||||
|
|
||||||
# noinspection DuplicatedCode
|
|
||||||
def generate_events_doc():
|
def generate_events_doc():
|
||||||
from platypush.message import event as event_module
|
_generate_components_doc(
|
||||||
|
index_name='events',
|
||||||
events_index = os.path.join(
|
package_name='message.event',
|
||||||
os.path.dirname(os.path.abspath(__file__)), 'docs', 'source', 'events.rst'
|
components=sorted(event for event in get_all_events().keys() if event),
|
||||||
)
|
|
||||||
events_dir = os.path.join(
|
|
||||||
os.path.dirname(os.path.abspath(__file__)),
|
|
||||||
'docs',
|
|
||||||
'source',
|
|
||||||
'platypush',
|
|
||||||
'events',
|
|
||||||
)
|
|
||||||
all_events = sorted(event for event in get_all_events().keys() if event)
|
|
||||||
|
|
||||||
for event in all_events:
|
|
||||||
event_file = os.path.join(events_dir, event + '.rst')
|
|
||||||
if not os.path.exists(event_file):
|
|
||||||
header = '``{}``'.format(event)
|
|
||||||
divider = '=' * len(header)
|
|
||||||
body = '\n.. automodule:: {}.{}\n :members:\n'.format(
|
|
||||||
event_module.__name__, event
|
|
||||||
)
|
|
||||||
out = '\n'.join([header, divider, body])
|
|
||||||
|
|
||||||
with open(event_file, 'w') as f:
|
|
||||||
f.write(out)
|
|
||||||
|
|
||||||
with open(events_index, 'w') as f:
|
|
||||||
f.write(
|
|
||||||
'''
|
|
||||||
Events
|
|
||||||
======
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 1
|
|
||||||
:caption: Events:
|
|
||||||
|
|
||||||
'''
|
|
||||||
)
|
)
|
||||||
|
|
||||||
for event in all_events:
|
|
||||||
f.write(' platypush/events/' + event + '.rst\n')
|
|
||||||
|
|
||||||
|
|
||||||
# noinspection DuplicatedCode
|
|
||||||
def generate_responses_doc():
|
def generate_responses_doc():
|
||||||
from platypush.message import response as response_module
|
_generate_components_doc(
|
||||||
|
index_name='responses',
|
||||||
responses_index = os.path.join(
|
package_name='message.response',
|
||||||
os.path.dirname(os.path.abspath(__file__)), 'docs', 'source', 'responses.rst'
|
components=sorted(
|
||||||
)
|
|
||||||
responses_dir = os.path.join(
|
|
||||||
os.path.dirname(os.path.abspath(__file__)),
|
|
||||||
'docs',
|
|
||||||
'source',
|
|
||||||
'platypush',
|
|
||||||
'responses',
|
|
||||||
)
|
|
||||||
all_responses = sorted(
|
|
||||||
response for response in get_all_responses().keys() if response
|
response for response in get_all_responses().keys() if response
|
||||||
|
),
|
||||||
)
|
)
|
||||||
|
|
||||||
for response in all_responses:
|
|
||||||
response_file = os.path.join(responses_dir, response + '.rst')
|
|
||||||
if not os.path.exists(response_file):
|
|
||||||
header = '``{}``'.format(response)
|
|
||||||
divider = '=' * len(header)
|
|
||||||
body = '\n.. automodule:: {}.{}\n :members:\n'.format(
|
|
||||||
response_module.__name__, response
|
|
||||||
)
|
|
||||||
out = '\n'.join([header, divider, body])
|
|
||||||
|
|
||||||
with open(response_file, 'w') as f:
|
|
||||||
f.write(out)
|
|
||||||
|
|
||||||
with open(responses_index, 'w') as f:
|
|
||||||
f.write(
|
|
||||||
'''
|
|
||||||
Responses
|
|
||||||
=========
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 1
|
|
||||||
:caption: Responses:
|
|
||||||
|
|
||||||
'''
|
|
||||||
)
|
|
||||||
|
|
||||||
for response in all_responses:
|
|
||||||
f.write(' platypush/responses/' + response + '.rst\n')
|
|
||||||
|
|
||||||
|
|
||||||
|
def main():
|
||||||
generate_plugins_doc()
|
generate_plugins_doc()
|
||||||
generate_backends_doc()
|
generate_backends_doc()
|
||||||
generate_events_doc()
|
generate_events_doc()
|
||||||
generate_responses_doc()
|
generate_responses_doc()
|
||||||
|
|
||||||
|
|
||||||
|
if __name__ == '__main__':
|
||||||
|
main()
|
||||||
|
|
||||||
|
|
||||||
# vim:sw=4:ts=4:et:
|
# vim:sw=4:ts=4:et:
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue