Refresh and simplify mkdocs instructions, and fix warnings emitted by mkdocs #15775
Conversation
This file contains 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
Excluding the "The following pages exist in the docs directory, but are not included in the "nav" configuration." INFO message.
|
Hmm, I didn't realize that it's already being handled. Then how about I open a PR with just the changes in src/docs/topics/docs-contributions/README.md instead? |
|
closed in favor of #15802 |
This was referenced May 1, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
I have noticed that the Running the documentation site locally documentation is a bit complicated. Specifically, altering the PATH is unnecessary, and the instructions still use
pip3instead ofpipeven though Python 2 has been fully dead since 2020. Also mkdocs' install guide URL has changed.Additionally, I fixed every INFO and WARN I saw in the mkdocs output, except the "The following pages exist in the docs directory, but are not included in the "nav" configuration." INFO message because I didn't want to alter the nav config.