Skip to content

docs: add script to Generate and Publish APIs into GitHub Pages #213

New issue

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

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

Already on GitHub? # to your account

Merged
merged 5 commits into from
Jun 25, 2021

Conversation

bednar
Copy link
Contributor

@bednar bednar commented Jun 25, 2021

Proposed Changes

  • generate-docs.sh - generate API documentation via docFx
  • publish-site.sh - publish generated API documentation to GitHub Pages

Generated docs: https://influxdata.github.io/influxdb-client-csharp/api/InfluxDB.Client.html

Checklist

  • CHANGELOG.md updated
  • Rebased/mergeable
  • dotnet test completes successfully
  • Commit messages are in semantic format
  • Sign CLA (if not already signed)

@bednar bednar marked this pull request as ready for review June 25, 2021 11:05
@bednar bednar requested a review from rhajek June 25, 2021 11:05
@codecov-commenter
Copy link

codecov-commenter commented Jun 25, 2021

Codecov Report

Merging #213 (534beb6) into master (589c275) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #213   +/-   ##
=======================================
  Coverage   85.22%   85.22%           
=======================================
  Files          71       71           
  Lines        6227     6227           
=======================================
  Hits         5307     5307           
  Misses        920      920           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 589c275...534beb6. Read the comment docs.

@bednar bednar merged commit 4b8c30e into master Jun 25, 2021
@bednar bednar deleted the docs/github-api-page branch June 25, 2021 11:32
@bednar bednar added this to the 2.0.0 milestone Jun 25, 2021
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants