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

Feature/documentation Github Actions #29

Merged
merged 11 commits into from
Jul 18, 2023

Conversation

rcmalli
Copy link
Collaborator

@rcmalli rcmalli commented Jul 18, 2023

Summary

  • We introduce Github actions for automatically build and deploy documentation after merge happens to main and dev branches.
  • This PR also fixes the broken links inside the documentation website and README.md file.
  • It also updates required dependencies for building documentation.

Type of Change

Please select the one relevant option below:

  • Bug fix (non-breaking change that solves an issue)
  • New feature (non-breaking change that adds functionality)

Checklist

Please confirm that the following tasks have been completed:

  • I have tested my changes locally and they work as expected. I run the mkdocs serve and checked the links
  • I have added unit tests for my changes, or updated existing tests if necessary.
  • I have updated the documentation, if applicable.
  • I have installed pre-commit and run locally for my code changes.

@rcmalli rcmalli added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 18, 2023
@rcmalli rcmalli added this to the v1.1.0 milestone Jul 18, 2023
@rcmalli rcmalli self-assigned this Jul 18, 2023
Copy link
Contributor

@lorenzomammana lorenzomammana left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@lorenzomammana lorenzomammana merged commit 1c96a65 into dev Jul 18, 2023
@lorenzomammana lorenzomammana deleted the feature/documentation_actions branch September 20, 2023 10:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants