Skip to content

Index issues for MHKiT-MATLAB and MHKiT-Python examples #17

@kmruehl

Description

@kmruehl

The MHKiT examples don't work with index. This is true for both MHKiT-MATLAB examples using MATLAB Live Scripts, and MHKiT-Python examples using Jupyter Notebooks.

  • MHKiT-MATLAB examples using MATLAB Live Scripts

    • HTML is generated by saving the MATLAB Live Script .mlx example files as *.html files
    • The MHKiT documentation then points to these *.html files within the MHKiT-MATLAB submodule
    • This means the index is removed when you navigate to the MHKiT-MATLAB examples within the documentation.
  • MHKiT-Python examples using Jupyter Notebooks

    • HTML is generated by using the nbsphinx_link extension
    • The MHKiT documentation uses *.nblink files to specify the location of the Jupyter Notebook *.ipynp files within the MHKiT-Python submodule
    • This means the index stays, but when you navigate to the MHKiT-Python examples within the documentation, but you lose your place in the index.

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't workingdocumentationImprovements or additions to documentationlaterIssue to resolve at a later date

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions