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

Add check for broken links in Doxygen generated html docs #5138

Open
wants to merge 4 commits into
base: develop
Choose a base branch
from

Conversation

hyoklee
Copy link
Member

@hyoklee hyoklee commented Nov 21, 2024

This PR will report 36 broken links.
CI will fail until they are all fixed.

close #4928

Copy link
Contributor

@byrnHDF byrnHDF left a comment

Choose a reason for hiding this comment

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

Add link check workflow

Copy link
Contributor

Choose a reason for hiding this comment

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

I think this would be better served by a dedicated workflow that just needs to configure and build on one platform then having it check on all the systems. After all the links don't change between platforms.

Copy link
Contributor

Choose a reason for hiding this comment

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

Also nothing in CMake tests finished because the Macs claim to not know about the command.

@byrnHDF
Copy link
Contributor

byrnHDF commented Nov 21, 2024

You could use the first 65 lines of the netcdf.yml file for the configure and build and then add the link check.

byrnHDF
byrnHDF previously approved these changes Nov 21, 2024
@byrnHDF
Copy link
Contributor

byrnHDF commented Nov 21, 2024

Could you add one more thing - put the actual linkcheck into a separate step

      - name: check
        run: |
          mkdir build
          cd build
          cmake -DHDF5_BUILD_DOC:BOOL=ON ..
          make doxygen
          cd hdf5lib_docs/html
          linkchecker --check-extern ./index.html

Change to:

      - name: create
        run: |
          mkdir build
          cd build
          cmake -DHDF5_BUILD_DOC:BOOL=ON ..
          make doxygen

     - name: check
        run: |
          cd build/hdf5lib_docs/html
          linkchecker --check-extern ./index.html

It would be easier to focus on the actual issues rather then scrolling through the build stuff.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component - Build CMake, Autotools Component - Documentation Doxygen, markdown, etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add check for broken links in Doxygen generated html docs.
2 participants