swiftlang / swift-docc-plugin

Swift Package Manager command plugin for Swift-DocC
https://swiftpackageindex.com/apple/swift-docc-plugin/1.3.0/documentation/swiftdoccplugin
Apache License 2.0
316 stars 54 forks source link

Generated documentation could not be viewed on GitHub pages saying "The page you’re looking for can’t be found" #54

Closed adarovsky closed 1 year ago

adarovsky commented 1 year ago

I used Swift-DocC plugin to preview documentation and it worked great. Then I followed instructions to publish documentation to GitHub pages, and when I try to view that, I get "The page you’re looking for can’t be found", while bottom bar is ok and there are no errors in browser network logs.

Checklist

Expected behavior

Main page should be shown.

Actual behavior

"The page you’re looking for can’t be found" message is shown in bold at the center of the screen.

Steps to Reproduce

  1. Clone https://github.com/tinkoff-mobile-tech/TinkoffConcurrency/tree/tech/documentation
  2. Run swift package --allow-writing-to-directory docs generate-documentation --target TinkoffConcurrency --disable-indexing --transform-for-static-hosting --hosting-base-path '/TinkoffConcurrency' --output-path ./docs

Swift-DocC Plugin Version Information

Swift-DocC plugin version: 1.2.0, latest main — results are the same. Swift Compiler version: Output from swiftc --version.

swift-driver version: 1.62.15 Apple Swift version 5.7.2 (swiftlang-5.7.2.135.5 clang-1400.0.29.51)
Target: arm64-apple-macosx12.0
adarovsky commented 1 year ago

https://tinkoff-mobile-tech.github.io/TinkoffConcurrency/documentation/tinkoffconcurrency/ worked as expected