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

Docs build fails with instrument view. #20

Closed
YooSunYoung opened this issue Jan 9, 2024 · 3 comments
Closed

Docs build fails with instrument view. #20

YooSunYoung opened this issue Jan 9, 2024 · 3 comments

Comments

@YooSunYoung
Copy link
Member

YooSunYoung commented Jan 9, 2024

Instrument view for NMX is not needed right now but it was useful for mcstas xml parser,
so I tried to add it in the documentation as well.

But the document build failed due to the output.
It fails complaining about the number of lines. It seems to be related to this issue.

ERROR: Line 404 exceeds the line-length-limit.
WARNING: Each notebook should have at least one section title

It leads to the failure of linking the notebook page to the main page, since it couldn't parse the title of the notebook.
It happened locally and also in the CI build. (The docs build test itself doesn't fail but the notebook is not included in the main page.)

scippneutron doesn't have this issue so there must be a solution.
For now the instrument view is included as a code snippet, not as a cell.

@nvaytet
Copy link
Member

nvaytet commented Jan 10, 2024

For now the instrument view is included as a code snippet, not as a cell.

Can you post a link to where this is done? I'd like to look at the code to see if I can figure out what's going on.

@YooSunYoung
Copy link
Member Author

For now the instrument view is included as a code snippet, not as a cell.

Can you post a link to where this is done? I'd like to look at the code to see if I can figure out what's going on.

Sorry...! Forgot to add the link. It's still in the open PR #18

@YooSunYoung
Copy link
Member Author

Fixed by #23

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