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

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

Open
1 of 2 tasks
kmruehl opened this issue Apr 28, 2020 · 1 comment
Open
1 of 2 tasks

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

kmruehl opened this issue Apr 28, 2020 · 1 comment
Labels
bug Something isn't working documentation Improvements or additions to documentation later Issue to resolve at a later date

Comments

@kmruehl
Copy link
Contributor

kmruehl commented Apr 28, 2020 •
edited
Loading

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.
@kmruehl kmruehl added bug Something isn't working documentation Improvements or additions to documentation labels Apr 28, 2020
@kmruehl kmruehl changed the title MHKiT examples index issues Index issues for MHKiT-MATLAB and MHKiT-Python examples May 11, 2020
@kmruehl kmruehl added the later Issue to resolve at a later date label May 18, 2020
@kmruehl
Copy link
Contributor Author

kmruehl commented Aug 3, 2020

Index issue with MHKiT-Python examples is resolved by e2a272f and discussed here #30

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug Something isn't working documentation Improvements or additions to documentation later Issue to resolve at a later date
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@kmruehl