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

Wrong file name is displayed if non-suffixed file specified in TOC is not found #50

Open
lbianchi-lbl opened this issue Jun 2, 2023 · 0 comments
Assignees
Labels
Priority:Normal Normal Priority Issue or PR

Comments

@lbianchi-lbl
Copy link
Contributor

lbianchi-lbl commented Jun 2, 2023

Noticed while working on #40.

Running idaesx build, the following message was displayed:

[ERROR] 2023-06-02 15:52:16,608 build - During 'pre-process notebooks': Could not find notebook at: /home/ludo/lbl/idaes/examples/idaes_examples/notebooks/docs/tut/general/i_src.ipynb
  • The reason for this is that a non-existent docs/tut/general/index.md was specified in _toc.yml (the path should have been docs/tut/index.md)
  • However, somewhere in the filename processing logic, the path stem index was processed as though it contained the _doc suffix to be stripped
  • The _doc-to-_src logic replaces the last 4 characters regardless of whether the stem contains the suffix or not, resulting in the erroneous i_src.ipynb name being constructed
lbianchi-lbl added a commit to luohezhiming/examples that referenced this issue Jun 2, 2023
lbianchi-lbl added a commit that referenced this issue Jun 2, 2023
* revise import errors

* move files to doc folder

* Add ipynb artifacts for tutorials

* Change tutorials position in TOC to address FileNotFound error

See #50

* Set missing generated data files to be ignored

* Try using a Markdown header to obtain a clearer sidebar entry

* Try removing ref to logo

* Add updated ipynb artifacts

---------

Co-authored-by: Ludovico Bianchi <lbianchi@lbl.gov>
@ksbeattie ksbeattie added the Priority:Normal Normal Priority Issue or PR label Jun 8, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Priority:Normal Normal Priority Issue or PR
Projects
None yet
Development

No branches or pull requests

3 participants