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

Fail docs build when there are broken links #535

Closed
wants to merge 27 commits into from

Conversation

mfisher87
Copy link
Collaborator

@mfisher87 mfisher87 commented Apr 20, 2024

Depends on #534


📚 Documentation preview 📚: https://earthaccess--535.org.readthedocs.build/en/535/

Andy Barrett and others added 27 commits February 20, 2024 13:53
Co-Authored-By: Brianna Pagán <[email protected]>
Co-Authored-By: Doug Newman <[email protected]>
Co-Authored-By: Arie Knoester <[email protected]>
Previously, the README file was symlinked into our docs. This led to a
problem where we could only write links that worked within one of the
two systems. Docs links need to be relative to the symlink to render
correctly, and GitHub README links need to be relative to the original
file to work correctly.
@mfisher87 mfisher87 changed the title Mkdocs strict mode Fail docs build when there are broken links Apr 20, 2024
@mfisher87
Copy link
Collaborator Author

INFO    -  Cleaning site directory
INFO    -  Building documentation to directory: /home/docs/checkouts/readthedocs.org/user_builds/earthaccess/checkouts/535/_readthedocs/html
INFO    -  The following pages exist in the docs directory, but are not included in the "nav" configuration:
  - contributing/development.md
  - contributing/releasing.md
  - howto/access-data.md
  - tutorials/getting-started.ipynb
WARNING -  Doc file 'quick-start.md' contains a relative link 'user_guide.qmd', but the target is not found among documentation files.
WARNING -  Doc file 'quick-start.md' contains a relative link 'how_to.qmd', but the target is not found among documentation files.
WARNING -  Doc file 'quick-start.md' contains a relative link 'authenticate.qmd', but the target is not found among documentation files.
INFO    -  Doc file 'contributing/index.md' contains an absolute link '/CODE_OF_CONDUCT.md', it was left as is.
INFO    -  Converting notebook (execute=True): /home/docs/checkouts/readthedocs.org/user_builds/earthaccess/checkouts/535/docs/howto/edl.ipynb
INFO    -  Converting notebook (execute=True): /home/docs/checkouts/readthedocs.org/user_builds/earthaccess/checkouts/535/docs/tutorials/SSL.ipynb
INFO    -  Converting notebook (execute=True): /home/docs/checkouts/readthedocs.org/user_builds/earthaccess/checkouts/535/docs/tutorials/emit-earthaccess.ipynb
INFO    -  Converting notebook (execute=True): /home/docs/checkouts/readthedocs.org/user_builds/earthaccess/checkouts/535/docs/tutorials/file-access.ipynb
INFO    -  Converting notebook (execute=True): /home/docs/checkouts/readthedocs.org/user_builds/earthaccess/checkouts/535/docs/tutorials/getting-started.ipynb
INFO    -  Converting notebook (execute=True): /home/docs/checkouts/readthedocs.org/user_builds/earthaccess/checkouts/535/docs/tutorials/restricted-datasets.ipynb
WARNING -  Doc file 'user_guide/overview.md' contains a relative link 'user_guide/authentication.md', but the target 'user_guide/user_guide/authentication.md' is not found among documentation files.
WARNING -  Doc file 'user_guide/overview.md' contains a relative link 'user_guide/search.md', but the target 'user_guide/user_guide/search.md' is not found among documentation files.
WARNING -  Doc file 'user_guide/overview.md' contains a relative link 'user_guide/access.md', but the target 'user_guide/user_guide/access.md' is not found among documentation files.

Aborted with 6 warnings in strict mode!

@mfisher87 mfisher87 closed this Apr 25, 2024
@mfisher87 mfisher87 deleted the mkdocs-strict-mode branch April 25, 2024 01:15
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