Skip to content

Commit

Permalink
docs: Don't use section-index plugin during klipper3d.org site genera…
Browse files Browse the repository at this point in the history
…tion

The section-index plugin can cause some confusing navigation.  Use the
simpler site navigation for now.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
  • Loading branch information
KevinOConnor committed Aug 17, 2021
1 parent b4ee930 commit bd0185c
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 18 deletions.
2 changes: 1 addition & 1 deletion docs/Config_Changes.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Configuration changes
# Configuration Changes

This document covers recent software changes to the config file that
are not backwards compatible. It is a good idea to review this
Expand Down
2 changes: 1 addition & 1 deletion docs/FAQ.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Frequently asked questions
# Frequently Asked Questions

1. [How can I donate to the project?](#how-can-i-donate-to-the-project)
2. [How do I calculate the rotation_distance config parameter?](#how-do-i-calculate-the-rotation_distance-config-parameter)
Expand Down
2 changes: 1 addition & 1 deletion docs/Overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ may require users to update their printer config file.
- [Contact](Contact.md): Information on bug reporting and general
communication with the Klipper developers.

## Configuration and Tuning Guides
## Installation and Configuration

- [Installation](Installation.md): Guide to installing Klipper.
- [Config Reference](Config_Reference.md): Description of config
Expand Down
27 changes: 12 additions & 15 deletions docs/_klipper3d/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,12 @@ markdown_extensions:
- toc:
permalink: True
toc_depth: 6
#- pymdownx.snippets
- attr_list
- mdx_partial_gfm
- mdx_truly_sane_lists
- mdx_breakless_lists
plugins:
- search
- section-index
- mkdocs-simple-hooks:
hooks:
on_page_markdown: "docs._klipper3d.mkdocs_hooks:transform"
Expand Down Expand Up @@ -72,28 +70,27 @@ extra:

# Navigation hierarchy (this should mimic the layout of Overview.md)
nav:
- Overview:
- Overview.md
- Features.md
- FAQ.md
- Releases.md
- Config_Changes.md
- Contact.md
- Configuration and Tuning:
- Overview.md
- Features.md
- FAQ.md
- Releases.md
- Config_Changes.md
- Contact.md
- Installation and Configuration:
- Installation.md
- Configuration reference:
- Configuration Reference:
- Config_Reference.md
- Rotation_Distance.md
- Config_checks.md
- Bed level:
- Bed Level:
- Bed_Level.md
- Delta_Calibrate.md
- Probe_Calibrate.md
- BLTouch.md
- Manual_Level.md
- Bed_Mesh.md
- Endstop_Phase.md
- Resonance compensation:
- Resonance Compensation:
- Resonance_Compensation.md
- Measuring_Resonances.md
- Pressure_Advance.md
Expand All @@ -105,7 +102,7 @@ nav:
- skew_correction.md
- Using_PWM_Tools.md
- G-Codes.md
- Developer documentation:
- Developer Documentation:
- Code_Overview.md
- Kinematics.md
- Protocol.md
Expand All @@ -116,7 +113,7 @@ nav:
- Benchmarks.md
- CONTRIBUTING.md
- Packaging.md
- Device specific documents:
- Device Specific Documents:
- Example_Configs.md
- SDCard_Updates.md
- RPi_microcontroller.md
Expand Down

0 comments on commit bd0185c

Please sign in to comment.