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

Fix inclusion of docs spec draft in docs build #8343

Merged
merged 1 commit into from
Jan 13, 2021

Conversation

florimondmanca
Copy link
Contributor

What does this PR do?

Cleanup for #7792

  • Fix undefined links
  • Add docs specs to nav, with a clear "warning: this is WIP" admonition.

Motivation

This is making the docs/build job on master and PRs fail currently:

INFO    -  The following pages exist in the docs directory, but are not included in the "nav" configuration:
  - meta/docs-specs.md 
WARNING -  mkdocstrings.plugin: meta/docs-specs.md: Could not find cross-reference target '[doc-spec-producer]' 
WARNING -  mkdocstrings.plugin: meta/docs-specs.md: Could not find cross-reference target '[doc-spec-templates]' 

Additional Notes

#7792 was opened in October 2020, and master has not been merged into it since then before merging. But meanwhile we merged #8152 which enabled --strict build mode that would surface the issues seen on master now that #7792 has been merged.

Review checklist (to be filled by reviewers)

  • Feature or bugfix MUST have appropriate tests (unit, integration, e2e)
  • PR title must be written as a CHANGELOG entry (see why)
  • Files changes must correspond to the primary purpose of the PR as described in the title (small unrelated changes should have their own PR)
  • PR must have changelog/ and integration/ labels attached

@florimondmanca florimondmanca merged commit 33243ef into master Jan 13, 2021
@florimondmanca florimondmanca deleted the fm/fix-docs-build branch January 13, 2021 11:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants