Add new mkdocs feature to suppress INFO output from nav; cleanup ai-testbed docs #246
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
INFO - The following pages exist in the docs directory, but are not included in the "nav" configuration:
felker
changed the title
|
There are/were tons of If a |
Closed
|
Sure Kyle,
Let me take a look at this.
Varuni
…________________________________
From: Kyle Gerard Felker ***@***.***>
Sent: Thursday, July 27, 2023 6:41 PM
To: argonne-lcf/user-guides ***@***.***>
Cc: Katti Sastry, Varuni ***@***.***>; Mention ***@***.***>
Subject: Re: [argonne-lcf/user-guides] Add new mkdocs feature to suppress INFO output from nav; cleanup ai-testbed docs (PR #246)
There are/were tons of .md and other files (scripts, YAML, pure HTML) that were scattered around the ai-testbed/ subfolder that were not navigable from other pages or from the sidebar. I have removed some, and moved others in unused/ subdirs to let main doc authors decide what to do with them. But we shouldnt let this repo get cluttered with dead/placeholder documentation and other files too often. @vksastry<https://github.com/vksastry> can you take a look?
If a .md file is not supposed to appear in the navigation sidebar, but is instead linked to by other docs, it is best to put it into a not_in_nav/ subdirectory to make it explicit that this choice is intentional.
—
Reply to this email directly, view it on GitHub<#246 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AVFQWJG3HG4TRWRF7GHUX4LXSL4CBANCNFSM6AAAAAAZFMMB64>.
You are receiving this because you were mentioned.Message ID: ***@***.***>
|
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.
Closes #173. Upcoming release of Mkdocs 1.5.x adds new options,
exclude_docs, not_in_navthat follow gitignore syntax. Will use this to suppress the many INFOs that get printed out:See mkdocs/mkdocs#3224 and mkdocs/mkdocs#1888
Related #162.
--strictand PR hook?not_in_nav; force doc writers (sbank, ai-testbed pages) to put such docs in specially named subdirectories.