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: Update to use yaml file #797

Merged
merged 1 commit into from
Sep 19, 2023
Merged

Docs: Update to use yaml file #797

merged 1 commit into from
Sep 19, 2023

Conversation

CamStan
Copy link
Member

@CamStan CamStan commented Sep 14, 2023

Description

Read the Docs has moved to a yaml file format that is needed to continue building our docs in the future. This adds that file.

This enables fail_on_warning to check for rst syntax errors when building. Builds for pull requests has also been enabled to add a status check to open pull requests. PR builds will be skipped if there are no changes to the docs. These features can easily be disabled if they don't work as desired.

Motivation and Context

Read the Docs will stop building any documentation not using this format in the near future.

How Has This Been Tested?

Docs were build in a test repo.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Performance enhancement (non-breaking change which improves efficiency)
  • Code cleanup (non-breaking change which makes code smaller or more readable)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Testing (addition of new tests or update to current tests)
  • Documentation (a change to man pages or other documentation)

Checklist:

  • My code follows the UnifyFS code style requirements.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.
  • All commit messages are properly formatted.

Read the Docs has moved to a yaml file format that is needed to
continue building our docs in the future. This adds that file.

This enables fail_on_warning to check for rst syntax errors when
building. Builds for pull requests has also been enabled to add a
status check to open pull requests. PR builds will be skipped if
there are no changes to the docs. These features can easily be
disabled if they don't work as desired.
@kathrynmohror kathrynmohror merged commit cfb3940 into LLNL:dev Sep 19, 2023
6 checks passed
@CamStan CamStan deleted the rtd_yaml branch December 20, 2023 20:20
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.

3 participants