mkdocs: Fix ref not found warnings #955
Merged
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.
(A rework of #926 to fix unresolvable rebase/merge conflicts)
Fix ref/doc not found warnings during spec doc generation.
Currently,
mkdocs serve
andmkdocs build
emit these warnings:The first 4 warnings are responsible to the four erroneous
None
class/properties displaying in the left pane of https://spdx.github.io/spdx-spec/v3.0/ . They are all old property names. New property names are already included in the nav. Fixed by removing all 4 outdated references:model/Software/Properties/isDirectory.md
is nowfileKind
model/Dataset/Classes/Dataset.md
is nowDatasetPackage
model/Dataset/Properties/sensitivePersonalInformation.md
is nowhasSensitivePersonalInformation
model/AI/Properties/sensitivePersonalInformation.md
is nowuseSensitivePersonalInformation
The remaining 2 warnings are fixed by add directory name to the targets in
conformance.md
:diffs-from-previous-editions.md
andSPDX-Lite.md
are inannexes/
directoryconformance.md
is not included yet in the 3.0 as the content is need to be updated for the version. So fixing these 2 warnings or not is not effecting what the public will see in the spec doc - yet, until we include the Conformance chapter to the spec.