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

docs: improve docs workflow #50

Merged
merged 2 commits into from
Nov 5, 2022
Merged

docs: improve docs workflow #50

merged 2 commits into from
Nov 5, 2022

Conversation

Lucino772
Copy link
Owner

Description

This PR improves the documentation workflow by using sphinx-autobuild. It also adds a custom workflow to deploy the documentation to Github Pages instead of ReadTheDocs.

Type of change

  • 📃 Documentation (Documentation only changes)

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code

@codecov
Copy link

codecov bot commented Nov 5, 2022

Codecov Report

Base: 67.92% // Head: 67.92% // No change to project coverage 👍

Coverage data is based on head (889e45c) compared to base (5e3fde1).
Patch has no changes to coverable lines.

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #50   +/-   ##
=======================================
  Coverage   67.92%   67.92%           
=======================================
  Files          27       27           
  Lines         901      901           
  Branches       83       83           
=======================================
  Hits          612      612           
  Misses        269      269           
  Partials       20       20           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@Lucino772 Lucino772 merged commit 6d4a9fe into main Nov 5, 2022
@Lucino772 Lucino772 deleted the docs/improve-workflow branch November 5, 2022 12:14
Lucino772 added a commit that referenced this pull request Nov 5, 2022
* docs: added edit button & github icon in footer

* chore(changes): added missing towncrier fragement for pull request #50

* chore(changes): added towncrier fragments for current pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant