platypush/platypush

Fork 4

[#311] Logic to automatically generate the documentation for the dependencies of the integrations #330

Merged

blacklight merged 5 commits from 311/auto-generate-deps-docs into master

2023-09-30 02:31:43 +02:00

blacklight commented

2023-09-24 17:02:16 +02:00

Owner

Added an add_dependencies plugin to the Sphinx build process that parses the manifest files of the scanned backends and plugins and automatically generates the documentation for the required dependencies and triggered events.

This means that those dependencies are no longer required to be listed in the docstring of the class itself.

Also in this commit:

Black/LINT for some integrations that hadn't been touched in a long time.
Deleted some leftovers from previous refactors (deprecated backend.mqtt, backend.zwave.mqtt, backend.http.request.rss).
Deleted deprecated inotify backend - replaced by file.monitor (see #289).

Closes: #311, #318

Added an `add_dependencies` plugin to the Sphinx build process that parses the manifest files of the scanned backends and plugins and automatically generates the documentation for the required dependencies and triggered events. This means that those dependencies are no longer required to be listed in the docstring of the class itself. Also in this commit: - Black/LINT for some integrations that hadn't been touched in a long time. - Deleted some leftovers from previous refactors (deprecated `backend.mqtt`, `backend.zwave.mqtt`, `backend.http.request.rss`). - Deleted deprecated `inotify` backend - replaced by `file.monitor` (see #289). Closes: #311, #318

blacklight added 1 commit 2023-09-24 17:02:16 +02:00

[#311 ] Docs deps autogen sphinx plugin.

continuous-integration/drone/push Build is passing

Details

c3337ccc6c

Added an `add_dependencies` plugin to the Sphinx build process that
parses the manifest files of the scanned backends and plugins and
automatically generates the documentation for the required dependencies
and triggered events.

This means that those dependencies are no longer required to be listed
in the docstring of the class itself.

Also in this commit:

- Black/LINT for some integrations that hadn't been touched in a long
  time.

- Deleted some leftovers from previous refactors (deprecated
  `backend.mqtt`, `backend.zwave.mqtt`, `backend.http.request.rss`).

- Deleted deprecated `inotify` backend - replaced by `file.monitor` (see
  #289).

blacklight added 1 commit 2023-09-26 23:50:51 +02:00

Moved BluetoothPlugin to __init__.py.

continuous-integration/drone/push Build is passing

Details

9298f52443

This is for consistency with other plugins, that all have their main
plugin class definition inside of `__init__.py`.

blacklight added 3 commits 2023-09-30 02:29:02 +02:00

Merge branch 'master' into 311/auto-generate-deps-docs 0a3ec4b9f1

Misc documentation improvements. 905d6632e0

New IntegrationMetadata generic util class.

continuous-integration/drone/push Build is passing

Details

343972b520

This object is in charge of parsing all the metadata of a
plugin/backend.

blacklight merged commit e6f05dfe07 into master

2023-09-30 02:31:43 +02:00

blacklight referenced this pull request from a commit

2023-09-30 02:31:45 +02:00

Merge pull request '[#311] Logic to automatically generate the documentation for the dependencies of the integrations' (#330) from 311/auto-generate-deps-docs into master

No reviewers

No labels

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: platypush/platypush#330

No description provided.

Rows
Columns