Ipynb input #874
Ipynb input #874
Conversation
| @@ -225,3 +254,38 @@ let ``Parses frontmatter correctly `` () = | |||
| twoTowersHtml |> shouldContainText "<a href=\"fellowship.html\">Previous</a>" | |||
| twoTowersHtml |> shouldContainText "<a href=\"return.html\">Next</a>" | |||
| returnHtml |> shouldContainText "<a href=\"two-tower.html\">Previous</a>" | |||
|
|
|||
|
|
|||
| (* Cannot get this test to evaluate the notebook | |||
There was a problem hiding this comment.
I have evaluate = true set for DocContent, which should trigger the external call to dotnet repl that runs the notebook and produces outputs for the cell . But for some reason the code calling out to dotnet repl isn't getting triggered inside this test. dotnet fsdocs --eval triggers notebook evaluation in a docs folder, but I have not been able to get it to work inside this test.
There was a problem hiding this comment.
Are you sure? This test is working for me in WSL.
nhirschey
force-pushed
the
ipynb-input
branch
from
727ceaf to
d4fe9fd
Compare
|
Sounds good, I'll bump the alpha release when I merge. Thanks for the code review and all your work on the modern theme. You've done incredible work the past month! |
|
@nojaf, just to double check that I don't mess up any of your in-progress work. Are you ok with this being merged into main now? I'm done and I've updated release notes to bump the release |
Why thank you 😊
Yes, go for it! |
If there are changes you'd suggest making to Microsoft.DotNet.Interactive.Documents`, please let us know. Ideally you'd be able to use this effectively from F# without needing to duplicate the effort. |
I'm the owner of |
Fixes #806. This code should be independent of everything else; only gets triggered on .ipynb input files. Could merge this into the modern theme branch for alphas or wait and merge into main after modern theme is complete.
The general strategy is to convert a notebook to markdown and then pass that markdown through FSharp.Formatting's existing markdown tools.
Parsing: This uses a custom parser to read notebooks as json. I tried using .NET Interactive's parser, but it requires mapping their undocumented internal C# classes to F# and at the end of the day it was easier to do the parsing from scratch.
Evaluation: relies on dotnet-repl, a personal project of someone on the .NET Interactive team. As recently as August they recommended it for commandline execution, so let's use it. The downside is that users must install this extra tool, but I don't think it's a big burden.
One thing @kMutagene, we have to decide what happens when we evaluate a notebook. What I did was have
fsdocs --evaltrigger dotnet-repl on the actual source notebook in the docs folder. This means that evaluating docs will change the content of the source notebooks (for example dotnet-repl puts some additional metadata in cells indicating time of execution). This seemed reasonable for now.Testing: I added tests, but one thing I couldn't test well was dotnet-repl evaluation. I couldn't get the test project to evaluate the notebooks using dotnet-repl. Maybe test projects cannot call external dotnet tools? I don't know. I left the test in there but it's commented out.