docs: Fix broken links with sphinx linkchecker#1200
Merged
joergsteffens merged 3 commits intobareos:masterfrom Jul 11, 2022
Merged
docs: Fix broken links with sphinx linkchecker#1200joergsteffens merged 3 commits intobareos:masterfrom
joergsteffens merged 3 commits intobareos:masterfrom
Conversation
a74d114 to
15ca1d4
Compare
15ca1d4 to
8bca558
Compare
joergsteffens
requested changes
Jul 7, 2022
Member
joergsteffens
left a comment
There was a problem hiding this comment.
I'm very glad you found and configured this tool.
I've suggestions on some of the internal URLs, but besides that, I'm fine with this PR.
docs/manuals/source/DocumentationStyleGuide/BareosSpecificFormatting/Issue.rst
Outdated
Show resolved
Hide resolved
docs/manuals/source/TasksAndConcepts/TheWindowsVersionOfBareos.rst
Outdated
Show resolved
Hide resolved
a060b6a to
fb35d97
Compare
- Adding linkcheck options to conf.py - Fix all broken link in documentation - Increase clarity for Windows download location - use short url for bareos domain: the redirection is excluded as error in linkcheck configuration. - xca use github devel project Sphinx linkcheck can be used during documentation build ```sphinx-build -M linkcheck docs/manuals/source docs/BareosMainReference -j2``` Co-authored-by: Jörg Steffens <joergsteffens@users.noreply.github.com> Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
Use the command make docs-check-urls to verify that all used links in the documentation are still valid. Exceptions can be configured in docs/manuals/source/conf.py As this command can be time consuming and error prone (due to internet or server problems), it is not configured to run automatically.
Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
58b4db8 to
6612d70
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation use sphinx linkcheck to fix broken links
Sphinx linkcheck can be used during documentation build
The automatic usage during documentation build, still need to be discussed.
Please check
If you have any questions or problems, please give a comment in the PR.
Helpful documentation and best practices
Checklist for the reviewer of the PR (will be processed by the Bareos team)
General
[ ] If backport: add original PR number and target branch at top of this file: Backport of PR#000 to bareos-2xSource code quality
bareos-check-sources --since-mergedoes not report any problemsgit statusshould not report modifications in the source tree after building and testing