-
Notifications
You must be signed in to change notification settings - Fork 99
Issues generating HTML documentation for Nuke #25
Comments
What I also noticed is that:
|
Thanks for your feedback, @kean! Responding really quick to your first point, about the incorrect (long) type names: I was seeing the same thing with #16, but thought it was limited to Linux. I'll be really happy if I can reproduce it locally with Nuke; that'll let me troubleshoot the issue much more easily. |
Thanks, @mattt! Most of the issues have been resolved. I still observe an issue with nested types.
Is it worth opening a separate issue? |
One more note, the HTML links in the documentation don't work if you browse it locally, which is a bit inconvenient. Jazzy on the other hand, works locally just fine. |
@kean Thanks for following up. I'll have a full response for you soon, but I wanted to address one quick thing:
It doesn't work if you open the html files directly, but you can make it work by running a local web server at the root of the generated directory. On macOS, the default Python distribution should provide a convenient, built-in solution:
Then in another terminal window:
|
Closing as the reported issue was fixed by #62. If I encounter more issues, I will report them separately. |
Hi Mattt, this looks absolutely fantastic and I would really like to start using swift-doc in my projects. I downloaded the latest swift-doc version from
master
(85b5872) and tried running it against Nuke's master.My command line tools are set to Xcode 11.4.
It seems it got a bit confused. I think it might be because of some of the "namespaces" and typealiases.
The actual types are named
ImageProcessors.GaussianBlur
, etc.Documentation.zip
The text was updated successfully, but these errors were encountered: