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.

Sign up for GitHub

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

Jump to bottom

Use MkDocs' not_in_nav #5498

Merged
merged 4 commits into from
Sep 19, 2023
Merged

Use MkDocs' not_in_nav #5498

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
8a8fdf2
Use MkDocs' `not_in_nav`
MicaelJarniac Jul 4, 2023
aa48d1e
Merge branch 'main' into not_in_nav
MicaelJarniac Jul 14, 2023
90d9a09
Merge branch 'main' into not_in_nav
charliermarsh Sep 18, 2023
5b89b36
Upgrade; fix references
charliermarsh Sep 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 3 additions & 3 deletions crates/ruff_dev/src/generate_docs.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ fn process_documentation(documentation: &str, out: &mut String) {

let anchor = option.replace('.', "-");
out.push_str(&format!("- [`{option}`][{option}]\n"));
after.push_str(&format!("[{option}]: ../../settings#{anchor}\n"));
after.push_str(&format!("[{option}]: ../settings.md#{anchor}\n"));

continue;
}
Expand Down Expand Up @@ -151,8 +151,8 @@ Something [`else`][other].

[other]: http://example.com.

[task-tags]: ../../settings#task-tags
[mccabe.max-complexity]: ../../settings#mccabe-max-complexity
[task-tags]: ../settings.md#task-tags
[mccabe.max-complexity]: ../settings.md#mccabe-max-complexity
"
);
}
Expand Down
2 changes: 1 addition & 1 deletion crates/ruff_dev/src/generate_rules_table.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ pub(crate) fn generate() -> String {
table_out.push('\n');

table_out.push_str(&format!(
"The {PREVIEW_SYMBOL} emoji indicates that a rule in [\"preview\"](../faq/#what-is-preview)."
"The {PREVIEW_SYMBOL} emoji indicates that a rule in [\"preview\"](faq.md#what-is-preview)."
));
table_out.push('\n');
table_out.push('\n');
Expand Down
4 changes: 2 additions & 2 deletions docs/requirements-insiders.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
PyYAML==6.0
black==23.3.0
mkdocs==1.4.3
git+ssh://git@github.com/astral-sh/mkdocs-material-insiders.git
mkdocs==1.5.0
git+ssh://git@github.com/astral-sh/mkdocs-material-insiders.git@38c0b8187325c3bab386b666daf3518ac036f2f4
2 changes: 1 addition & 1 deletion docs/requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
PyYAML==6.0
black==23.3.0
mkdocs==1.4.3
mkdocs==1.5.0
mkdocs-material==9.1.18
2 changes: 2 additions & 0 deletions mkdocs.template.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@ plugins:
- search
extra_css:
- stylesheets/extra.css
not_in_nav: |
/rules/*
extra:
analytics:
provider: fathom