Section index pages seems not work #3361

aborruso · 2021-12-18T13:55:57Z

Contribution guidelines

I've read the contribution guidelines and wholeheartedly agree

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

I have set these features here:

  features:
    - navigation.top
    - navigation.tabs
    - navigation.sections
    - search.highlight
    - search.share
    - search.suggest
    - navigation.tracking

And this is my navigation:

nav:
    - Home: README.md
    - Guida:
      - Introduzione: introduzione/README.md
      - Formato di dati tabellari: formato_dati_tabellari/README.md
      - Dizionario: dizionario_dati/README.md
      - Linee guida pubblicazione:
          - linee_guida_pubblicazione_file/index.md
          - Singola riga intestazione: linee_guida_pubblicazione_file/P01_unica_riga_intestazione.md
    - Partecipa: partecipa.md
    - Note: note_redazione.md

Why Linee guida pubblicazione is not linked to the section index file, and I have the index file below the section name in the tree?

Expected behaviour

To have the section in tree linked to index file

Actual behaviour

The section is not linked to the index file

Steps to reproduce

I have inserted all my source file.

This is the repo https://github.com/ondata/guidaPraticaPubblicazioneCSV

Package versions

Python: python --version 3.9.2
MkDocs: mkdocs --version 1.2.3
Material: pip show mkdocs-material | grep -E ^Version 8.1.0

Configuration

site_name: Guida per la pubblicazione di CSV
site_url:  https://ondata.github.io/guidaPraticaPubblicazioneCSV/
site_description: Guida pratica per la pubblicazione di dati tabellari in formato CSV


repo_url: https://github.com/ondata/guidaPraticaPubblicazioneCSV
repo_name: guidaPubblicazioneCSV
edit_uri: edit/main/docs/

copyright: 'Questa guida è un progetto dell''<a href="https://twitter.com/ondatait" target="_blank">associazione onData</a> | licenza <a href="https://creativecommons.org/licenses/by-sa/4.0/deed.it" target="_blank">CC BY-SA 4.0</a>'

theme:
  name: material
  icon:
    logo: material/table
  highlightjs: true
  custom_dir: overrides
  favicon: imgs/favicon.ico
  palette:
    - scheme: preference
      primary: deep purple
      accent: orange
      toggle:
        icon: material/weather-night
        name: Switch to dark mode
    - scheme: slate
      primary: deep purple
      accent: orange
      toggle:
        icon: material/weather-sunny
        name: Switch to light mode
  language: it
  features:
    - navigation.top
    - navigation.tabs
    - navigation.sections
    - search.highlight
    - search.share
    - search.suggest
    - navigation.tracking
  font:
    text: Montserrat
    #code: Cutive Mono
    code: Fira Code


nav:
    - Home: README.md
    - Guida:
      - Introduzione: introduzione/README.md
      - Formato di dati tabellari: formato_dati_tabellari/README.md
      - Dizionario: dizionario_dati/README.md
      - Linee guida pubblicazione:
          - linee_guida_pubblicazione_file/index.md
          - Singola riga intestazione: linee_guida_pubblicazione_file/P01_unica_riga_intestazione.md
    - Partecipa: partecipa.md
    - Note: note_redazione.md

extra:
 social:
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/ondatait

# foglio di stile personalizzato
extra_css:
  - stylesheets/style.css

plugins:
  - search:
      lang: it
  - mkdocstrings
  - mermaid2

extra_javascript:
  - https://cdnjs.cloudflare.com/ajax/libs/tablesort/5.2.1/tablesort.min.js
  - javascripts/tables.js
  - javascripts/varie.js
  - https://unpkg.com/mermaid/dist/mermaid.min.js

markdown_extensions:
- admonition
- md_in_html
- attr_list
- footnotes
- meta
- mkdocs-click
- pymdownx.keys
- pymdownx.betterem:
      smart_enable: all
- pymdownx.caret
- pymdownx.critic:
      mode: view
- pymdownx.details
- pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
- pymdownx.highlight
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:mermaid2.fence_mermaid
- pymdownx.tabbed
- pymdownx.tasklist:
      custom_checkbox: true
      clickable_checkbox: true
- pymdownx.tilde
- toc:
      permalink: true
      toc_depth: 3



### System information

- Operating system:  win10
- Browser: Version 96.0.4664.110 (Official Build) (64-bit)

The text was updated successfully, but these errors were encountered:

squidfunk · 2021-12-18T18:05:09Z

You need to enable navigation.indexes alongside navigation.sections, as those are two separate features (that work together).

aborruso · 2021-12-18T19:13:18Z

You need to enable navigation.indexes alongside navigation.sections, as those are two separate features (that work together).

Thank you very much, but please be patient, there is something more that I do not understand.

If I add navigation.indexes to this feature

  features:
    - navigation.top
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - search.highlight
    - search.share
    - search.suggest
    - navigation.tracking

all subsections disappear. How to have both index pages and sections?

squidfunk · 2021-12-18T20:47:47Z

Material for MkDocs only supports a single index.md (or README.md which is the same for MkDocs). If you rename the files of those pages they will reappear.

aborruso · 2021-12-18T23:43:24Z

Material for MkDocs only supports a single index.md (or README.md which is the same for MkDocs).

Thank you very much. Where can I read about it?

If you rename the files of those pages they will reappear.

I have renamed all file. This is my new nav:

nav:
    - Home: index.md
    - Guida:
      - guida/introduzione.md
      - Formato di dati tabellari: guida/formato_dati_tabellari.md
      - Dizionario: guida/dizionario_dati.md
      - Linee guida pubblicazione:
          - guida/linee_guida_pubblicazione.md
          - Singola riga intestazione: guida/P01_unica_riga_intestazione.md
    - Partecipa: partecipa.md
    - Note: note_redazione.md

These my features:

  features:
    - navigation.indexes
    - navigation.sections
    - navigation.tabs
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest

But my two sections are not linked to any document.

aborruso · 2021-12-19T08:50:39Z

Material for MkDocs only supports a single index.md (or README.md which is the same for MkDocs).

I finally understood and solved: you cannot have two index files at the same hierarchical level of navigation, but you can have multiple index files,

Probably I will propose you some PR in your great documentation site.

Thank you

Related to: > Material for MkDocs only supports a single index.md (or README.md which is the same for MkDocs). If you rename the files of those pages they will reappear. squidfunk#3361 (comment)

squidfunk · 2021-12-19T10:12:54Z

f3926bf fixes the issue. Subsequent index.md or README.md files are now included in the navigation.

aborruso · 2021-12-19T10:21:13Z

f3926bf fixes the issue. Subsequent index.md or README.md files are now included in the navigation.

I felt stupid. Glad to have been useful, I was a little crazy with a thousand tries

Thank you

squidfunk · 2021-12-19T10:32:22Z

No worries! The navigation template is very complex, which is why I didn't consider fixing this case in the first place, but sometimes a second look with fresh eyes reveals a solution that is much simpler than everything considered before 😉

squidfunk · 2021-12-19T12:52:35Z

Released as part of 8.1.3.

pawamoy · 2021-12-30T12:25:08Z

That seems to break the integration with mkdocs-section-index, /cc @oprypin.

With mkdocs-section-index 0.3.2, released Oct. 2, and

mkdocs-material 8.1.2: links are appearing as expected
mkdocs-material 8.1.3: the links under a section index disappear

Snippets of my setup:

$ tree docs/                                                                                                                                                                                            
docs/
├── index.md
└── reference
    ├── testing
    │   ├── examples.md
    │   ├── index.md
    │   └── models.md
    └── SUMMARY.md

SUMMARY.md

* [testing](testing/index.md)
    * [examples](testing/examples.md)
    * [models](testing/models.md)

# mkdocs.yml (minimum contents)

nav:
- Home:
  - Overview: index.md
- Code Reference: reference/

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

markdown_extensions:
- toc

plugins:
- search
- literate-nav:
    nav_file: SUMMARY.md
- section-index

oprypin · 2021-12-30T12:44:58Z

@pawamoy Yes, this broke that in a way that was hard to notice.
But, it's tracked as oprypin/mkdocs-section-index#10 - can't really say something is faulty here. So it's not useful to bring up here, unless as part of a (repeat) proposal to not force that plugin to hack into the template. #2060

pawamoy · 2021-12-30T12:50:41Z

Ah, apologies to you both for not checking mkdocs-section-index's issue tracker! Thanks @oprypin

squidfunk closed this as completed Dec 18, 2021

squidfunk reopened this Dec 18, 2021

aborruso closed this as completed Dec 19, 2021

aborruso mentioned this issue Dec 19, 2021

Added a warning about index file and sections #3362

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Section index pages seems not work #3361

Section index pages seems not work #3361

aborruso commented Dec 18, 2021

squidfunk commented Dec 18, 2021

aborruso commented Dec 18, 2021

squidfunk commented Dec 18, 2021

aborruso commented Dec 18, 2021

aborruso commented Dec 19, 2021

squidfunk commented Dec 19, 2021

aborruso commented Dec 19, 2021

squidfunk commented Dec 19, 2021

squidfunk commented Dec 19, 2021

pawamoy commented Dec 30, 2021 •

edited

Loading

oprypin commented Dec 30, 2021

pawamoy commented Dec 30, 2021

Section index pages seems not work #3361

Section index pages seems not work #3361

Comments

aborruso commented Dec 18, 2021

Contribution guidelines

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

Description

Expected behaviour

Actual behaviour

Steps to reproduce

Package versions

Configuration

squidfunk commented Dec 18, 2021

aborruso commented Dec 18, 2021

squidfunk commented Dec 18, 2021

aborruso commented Dec 18, 2021

aborruso commented Dec 19, 2021

squidfunk commented Dec 19, 2021

aborruso commented Dec 19, 2021

squidfunk commented Dec 19, 2021

squidfunk commented Dec 19, 2021

pawamoy commented Dec 30, 2021 • edited Loading

oprypin commented Dec 30, 2021

pawamoy commented Dec 30, 2021

pawamoy commented Dec 30, 2021 •

edited

Loading