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
Relationship between hosting-base-path and actual URLs is not very clear #698
Comments
Hi @dabrahams – thanks for filing this! Definitely work to do here. Have you seen the DocC-Plugin docs on this? https://apple.github.io/swift-docc-plugin/documentation/swiftdoccplugin/publishing-to-github-pages#Publishing-the-Documentation-Site I think that's the best we currently have – but agreed that there's more to do. |
I have seen that. Very inadequate I'm afraid; it doesn't even show |
It does include instructions around
At least at the time the documentation was written |
Not the section you linked to I'm afraid. There's something above that.
Whatever it takes to know how to set the option given that the directory in I would be able to test this information by using the technique you described here with an appropriate URL.
🤷 I am generating into a directory called |
Description
I'm having the most confounding time configuring docc, or understanding where to find the pages it generates. I've struggled with this in the past too, and got past it but somehow failed to internalize the answers. Maybe someone can help me (and hopefully, address this usability problem I seem to keep bumping into).
Here's a doc generation run. I expect to find the pages for the Core target at https://www.hylo-lang.org/hyloc/docc/Core/, similar to the pages generated by jazzy (this way) which are easy to find at https://www.hylo-lang.org/hyloc/jazzy/Core/. As you can see from the former URL, we get docc's custom 404 page but nothing interesting.
I recall somewhere docc was injecting /documentation/ into the paths somewhere, but I don't think I understand the rules.
In fact when I run the same commands locally, I get a site that refers to a theme-settings.json that doesn't seem to be anywhere in the directory tree.
Ugh, after digging around in my local filesystem, I find the results at https://www.hylo-lang.org/hyloc/docc/Core/documentation/core/. If I capitalize the 2nd "core" or lowercase the first one, it doesn't work. Maybe I'll just file this usability issue.
Checklist
main
branch of this package.Expected Behavior
No response
Actual behavior
No response
Steps To Reproduce
No response
Swift-DocC Version Information
No response
Swift Compiler Version Information
No response
The text was updated successfully, but these errors were encountered: