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

Update ReleaseNotes.rst #26

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions .github/templates/validate-sphinx-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
name: validate-sphinx-docs

# Were we can define the inputs that our action will accept
inputs:
path:
required: true

runs:
using: "composite"
steps:
- name: Validate Sphinx documentation in ${{ inputs.path }}
uses: ammaraskar/sphinx-action@master
with:
docs-folder: ${{ inputs.path }}
build-command: "sphinx-build -b html . _build -Dsuppress_warnings=toc.not_readable"
pre-build-command: "apt-get update -y && apt-get install -y python3-sphinx python3-recommonmark"
74 changes: 74 additions & 0 deletions .github/workflows/documentation-checks.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
name: Checking Documentation

on:
pull_request:
path: '**/docs/**/*.rst'

jobs:
verify-sphinx-documentation:
runs-on: ubuntu-latest
env:
SPHINX_ACTION: "./.github/templates/validate-sphinx-docs"
steps:
- name: Checkout
uses: actions/checkout@v4

- name: Check Bolt documentation
uses: "./.github/templates/validate-sphinx-docs"
with:
path: ./bolt/docs

- name: Check Clang documentation
uses: "./.github/templates/validate-sphinx-docs"
with:
path: ./clang/docs

- name: Check Clang Tools documentation
uses: "./.github/templates/validate-sphinx-docs"
with:
path: ./clang-tools-extra/docs

- name: Check Flang documentation
uses: "./.github/templates/validate-sphinx-docs"
with:
path: ./flang/docs

- name: Check libc documentation
uses: "./.github/templates/validate-sphinx-docs"
with:
path: ./libc/docs

- name: Check libcxx documentation
uses: "./.github/templates/validate-sphinx-docs"
with:
path: ./libcxx/docs

- name: Check libunwind documentation
uses: "./.github/templates/validate-sphinx-docs"
with:
path: ./libunwind/docs

- name: Check lldb documentation
uses: "./.github/templates/validate-sphinx-docs"
with:
path: ./lldb/docs

- name: Check lld documentation
uses: "./.github/templates/validate-sphinx-docs"
with:
path: ./lld/docs

- name: Check llvm documentation
uses: "./.github/templates/validate-sphinx-docs"
with:
path: ./llvm/docs

- name: Check openmp documentation
uses: "./.github/templates/validate-sphinx-docs"
with:
path: ./openmp/docs

- name: Check polly documentation
uses: "./.github/templates/validate-sphinx-docs"
with:
path: ./polly/docs
2 changes: 1 addition & 1 deletion clang/docs/ReleaseNotes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -263,7 +263,7 @@ Bug Fixes to C++ Support

- Fix a crash caused by substitution failure in expression requirements.
(`#64172 <https://github.com/llvm/llvm-project/issues/64172>`_) and
(`#64723 <https://github.com/llvm/llvm-project/issues/64723>`_).
(`#64723 <https://github.com/llvm/llvm-project/issues/64723>).

- Fix crash when parsing the requires clause of some generic lambdas.
(`#64689 <https://github.com/llvm/llvm-project/issues/64689>`_)
Expand Down
Loading