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)
[ ] 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.
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
Checklist:
autopep8second level aggressive.isort.cd docs && make spelling && make htmlpass (required if documentation has been updated.)pytest tests/ -vvpass. (required).pytype -d import-error sinergym/pass. (required)Changelog: