Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

build: publish python API docs #342

Merged
merged 5 commits into from
Mar 26, 2021
Merged

build: publish python API docs #342

merged 5 commits into from
Mar 26, 2021

Conversation

ivelin
Copy link
Collaborator

@ivelin ivelin commented Mar 26, 2021

Purpose

Generate and publish latest python code docs as part of CI runs

Approach

Github action that uses pdoc3 to extract docs from python source and build static html files. Then publish to github pages.

Merge Checklist

  • The code change is tested and works locally.
  • The user and dev documentation is up to date.

@commit-lint
Copy link

commit-lint bot commented Mar 26, 2021

Build System

Documentation

Contributors

ivelin

Commit-Lint commands

You can trigger Commit-Lint actions by commenting on this PR:

  • @Commit-Lint merge patch will merge dependabot PR on "patch" versions (X.X.Y - Y change)
  • @Commit-Lint merge minor will merge dependabot PR on "minor" versions (X.Y.Y - Y change)
  • @Commit-Lint merge major will merge dependabot PR on "major" versions (Y.Y.Y - Y change)
  • @Commit-Lint merge disable will desactivate merge dependabot PR
  • @Commit-Lint review will approve dependabot PR
  • @Commit-Lint stop review will stop approve dependabot PR

@codecov
Copy link

codecov bot commented Mar 26, 2021

Codecov Report

Merging #342 (ead46b2) into master (dce58c8) will not change coverage.
The diff coverage is n/a.

❗ Current head ead46b2 differs from pull request most recent head ec786ae. Consider uploading reports for the commit ec786ae to get more accurate results
Impacted file tree graph

@@           Coverage Diff           @@
##           master     #342   +/-   ##
=======================================
  Coverage   94.56%   94.56%           
=======================================
  Files          23       23           
  Lines        2228     2228           
=======================================
  Hits         2107     2107           
  Misses        121      121           

@pull-request-size pull-request-size bot added size/M and removed size/S labels Mar 26, 2021
@pull-request-size pull-request-size bot added size/L and removed size/M labels Mar 26, 2021
@pull-request-size pull-request-size bot added size/M and removed size/L labels Mar 26, 2021
@ivelin ivelin merged commit 2091c54 into master Mar 26, 2021
@ivelin ivelin deleted the ivelin-pdoc branch March 26, 2021 23:45
github-actions bot pushed a commit that referenced this pull request Mar 27, 2021
## [1.14.7](v1.14.6...v1.14.7) (2021-03-27)

### Bug Fixes

* build and publish python API docs ([2091c54](2091c54)), closes [#342](#342)
@github-actions
Copy link

🎉 This PR is included in version 1.14.7 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

github-actions bot pushed a commit to ivelin/ambianic-edge that referenced this pull request May 17, 2021
## [1.11.1](v1.11.0...v1.11.1) (2021-05-17)

### Bug Fixes

* build and publish python API docs ([2091c54](2091c54)), closes [ambianic#342](https://github.com/ivelin/ambianic-edge/issues/342)
* improve fall detection debug info ([7762752](7762752)), closes [ambianic#309](https://github.com/ivelin/ambianic-edge/issues/309)
* json serialization redundancy issue in store.py; closes [ambianic#337](https://github.com/ivelin/ambianic-edge/issues/337); closes [ambianic#300](https://github.com/ivelin/ambianic-edge/issues/300) ([bb8d20a](bb8d20a)), closes [ambianic#339](https://github.com/ivelin/ambianic-edge/issues/339)
* revert [ambianic#314](https://github.com/ivelin/ambianic-edge/issues/314); see [ambianic#330](https://github.com/ivelin/ambianic-edge/issues/330) for details; separate inference output formatting for each detection model; closes [ambianic#254](https://github.com/ivelin/ambianic-edge/issues/254)" ([ee79c40](ee79c40)), closes [ambianic#329](https://github.com/ivelin/ambianic-edge/issues/329)
* separate inference output formatting for each detection model; [issues [ambianic#330](https://github.com/ivelin/ambianic-edge/issues/330), [ambianic#254](https://github.com/ivelin/ambianic-edge/issues/254)] ([b83e4f8](b83e4f8)), closes [ambianic#332](https://github.com/ivelin/ambianic-edge/issues/332)
* separate inference output formatting for each detection model; closes [ambianic#254](https://github.com/ivelin/ambianic-edge/issues/254) ([8768c17](8768c17)), closes [ambianic#314](https://github.com/ivelin/ambianic-edge/issues/314)
* temporary solution to manage yaml.dump() encoding issue; closes [ambianic#330](https://github.com/ivelin/ambianic-edge/issues/330) ([db4b00a](db4b00a)), closes [ambianic#333](https://github.com/ivelin/ambianic-edge/issues/333)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant