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

v(3.5.11) - GitHub Pages and documentation compilation in actions improvement #445

Merged
merged 17 commits into from
Sep 18, 2024

Conversation

AlejandroCN7
Copy link
Member

Description

This update separates documentation builds from the rest of the project, with all builds now hosted on the github-pages branch.

Additionally, the project's documentation has been streamlined by mocking the external dependencies of the sinergym module, which reduces the environment requirements in GitHub Actions for deployment automation.

As a result, GitHub Actions workflows have been optimized to make documentation processes simpler and more efficient, and builds have been removed from the main branch.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation (update in the documentation)
  • Improvement (of an existing feature)
  • Others

Checklist:

  • I've read the CONTRIBUTION guide (required)
  • My change requires a change to the documentation.
  • I have updated the tests.
  • I have updated the documentation accordingly.
  • I have reformatted the code using autopep8 second level aggressive.
  • I have reformatted the code using isort.
  • I have ensured cd docs && make spelling && make html pass (required if documentation has been updated.)
  • I have ensured pytest tests/ -vv pass. (required).
  • I have ensured pytype -d import-error sinergym/ pass. (required)

Changelog:

  • Add gcloud and google.cloud to documentations mocks.
  • Added a mock class and overwrite WandBOutputFormat (stable baselines 3 dependency).
  • Update documentation year.
  • Update documentation modules with new mocks.
  • Added Python EnergyPlus API to the sphinx mock.
  • Github Actions: Documentation process en PR and main push updated, minimal installation required and redirect documentation push to github-pages branch.

@AlejandroCN7 AlejandroCN7 merged commit 5626aa8 into main Sep 18, 2024
4 checks passed
@AlejandroCN7 AlejandroCN7 deleted the feat/github-pages-imp branch September 18, 2024 12:27
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.

1 participant