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

Version 7.3.1 introduced regression for some plugins #3072

Closed
5 tasks done
jaklan opened this issue Oct 2, 2021 · 3 comments
Closed
5 tasks done

Version 7.3.1 introduced regression for some plugins #3072

jaklan opened this issue Oct 2, 2021 · 3 comments

Comments

@jaklan
Copy link

jaklan commented Oct 2, 2021

Contribution guidelines

I've found a bug and checked that ...

  • ... the problem doesn't occur with the mkdocs or readthedocs themes
  • ... the problem persists when all overrides are removed, i.e. custom_dir, extra_javascript and extra_css
  • ... the documentation does not mention anything about my problem
  • ... there are no open or closed issues that are related to my problem

Description

As you can see at the pictures below, after upgrading mkdocs-material to 7.3.1 (from 7.3.0) the navigation is broken when using the mkdocs-section-index plugin - names of the sections and arrows seem to be in the reverse order. For now I don't know if any other plugins are affected by the update, but as it was the patch update - nothing should be broken anyway.

PS I know the theme has this functionality available out-of-the-box, but I use for the reason described in the #3071 issue.

Expected behaviour

image

Actual behaviour

image

Steps to reproduce

  1. Install section-index plugin.
  2. Create docs/projects/project-name/docs dirs.
  3. Create an index.md file in the last dir (and optionally some other Markdown files).
  4. Enable section-index plugin.
  5. Run mkdocs serve.

Package versions

  • Python: 3.8.12
  • MkDocs: 1.2.2
  • Material: 7.3.1

Configuration

site_name: Whatever

plugins:
  - section-index

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.top

System information

  • Operating system: macOS
  • Browser: Chrome
@squidfunk
Copy link
Owner

squidfunk commented Oct 2, 2021

Thanks for reporting. The mkdocs-section-indexplugin is not officially supported, as Material for MkDocs has native support for this feature. Thus, this issue should be raised to the plugin authors. Also, this issue was already fixed in #3071.

@jaklan
Copy link
Author

jaklan commented Oct 2, 2021

@squidfunk I see, but it doesn't mean the patch release introduced some breaking changes, if the plugin crashed unexpectedly? If yes, it should be probably a major release then.

@squidfunk
Copy link
Owner

No. We can't do a major release every time we change templates. This is a template project. There will always be breaking changes, depending on how you use it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants