Error when publishing to GitHub Pages

[leif-ibsen]

Description

The problem is described in issue #808.

Please, see my last comment from 8. of february in that issue.

Checklist

• If possible, I've reproduced the issue using the main branch of this package.
• This issue hasn't been addressed in an existing GitHub issue.

Expected Behavior

The bug is documented and can be reproduced at this location:

https://leif-ibsen.github.io/DocCTest/documentation/docctest

Actual behavior

Steps To Reproduce

The bug is documented and can be reproduced at this location:

https://leif-ibsen.github.io/DocCTest/documentation/docctest

Swift-DocC Version Information

No response

Swift Compiler Version Information

No response

[leif-ibsen]

I tried to use the new toolchain

swift-DEVELOPMENT-SNAPSHOT-2024-02-12-a.xctoolchain

to build the DocCTest documentation for GitHub Pages.
I still get

The page you're looking for can't be found.

messages when looking at the generated documentation, as you will see if you click

https://leif-ibsen.github.io/DocCTest/documentation/docctest

There were no errors during the build but many warnings like

objc[1311]: Class _TtCC11swiftASTGen13SourceManager21MacroExpansionContext is implemented in both 
/Library/Developer/Toolchains/swift-DEVELOPMENT-SNAPSHOT-2024-02-12-a.xctoolchain/usr/lib/swift/host/lib_InternalSwiftScan.dylib (0x142dd02d0) 
and /Applications/Xcode.app/Contents/Developer/Toolchains/XcodeDefault.xctoolchain/usr/lib/swift/host/lib_InternalSwiftScan.dylib (0x111ea8c00). 
One of the two will be used. Which one is undefined.

[leif-ibsen]

The error occurs when you click the following operators:

/ /= % %= < <= > >= << <<= >> >>= | |= ^ ^= ~

The following operators work ok:

• += - -= * *= == != & &=

[leif-ibsen]

The bug is documented and can be reproduced at this location:

https://leif-ibsen.github.io/DocCTest/documentation/docctest

The DocCTest source code is here:

https://github.com/leif-ibsen/DocCTest

[d-ronnqvist]

I don't know how I can reproduce this.

If I build documentation for that repo with the Xcode 15.3 release build I can view all those pages. At first I thought that it could be an issue with the static hosting files being different but if I locally serve the built documentation with python3 -m http.server 8080 I can still browse all those pages.

[leif-ibsen]

If I preview the documentation (using Xcode 15.3) with the command

swift package --disable-sandbox preview-documentation --target DocCTest

everything work okay. I can see all the pages locally on my computer.

However, if I build for GitHub Pages (also using Xcode 15.3) with the command

swift package --allow-writing-to-directory ./docs generate-documentation \
--target DocCTest --disable-indexing --transform-for-static-hosting \
--hosting-base-path DocCTest --output-path ./docs

and then push the build to GitHub, then the error occurs. Look at the documentation
at the location

https://leif-ibsen.github.io/DocCTest/documentation/docctest

and if you click, say the BInt operator /, you should see

The page you're looking for can't be found.

That's what I experience.

[leif-ibsen]

If I preview the documentation (using Xcode 15.3) with the command swift package --disable-sandbox preview-documentation --target DocCTest everything work okay. I can see all the pages locally on my computer. However, if I build for GitHub Pages (also using Xcode 15.3) with the command swift package --allow-writing-to-directory ./docs generate-documentation \ --target DocCTest --disable-indexing --transform-for-static-hosting \ --hosting-base-path DocCTest --output-path ./docs and then push the build to GitHub, then the error occurs. Look at the documentation at the location https://leif-ibsen.github.io/DocCTest/documentation/docctest and if you click, say the BInt operator /, you should see The page you're looking for can't be found. That's what I experience.

…

Den 8. mar. 2024 kl. 16.07 skrev David Rönnqvist ***@***.***>: I don't know how I can reproduce this. If I build documentation for that repo with the Xcode 15.3 release build I can view all those pages. At first I thought that it could be an issue with the static hosting files being different but if I locally serve the built documentation with python3 -m http.server 8080 I can still browse all those pages. — Reply to this email directly, view it on GitHub <#820 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ANEVD3A62VBQTA2WKYXHV6DYXHHZZAVCNFSM6AAAAABDBKUHF2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSOBVHA2TSMZXGA>. You are receiving this because you authored the thread.

[leif-ibsen]

The issue is marked with 'needs more information'.

As I have explained, if I build the documentation and view it locally on my PC,
everything works ok.

However, when the documentation is pushed to GitHub Pages and viewed there,
the error occurs.

I have documented that at the location

https://leif-ibsen.github.io/DocCTest/documentation/docctest/

Is there more information I can provide to help solve this?

The operators that produce the error on GitHub Pages, are:

/ /= % %= | |= ^ ^= ~ << <<= >> >>= < <= > >=

[JessyCatterwaul]

I experienced the same problem today, with an ¿? operator.

[leif-ibsen]

Interesting Jessy. I included the ¿? operator in my DocCTest test application and when I build the application and viewed the documentation locally on my MacBook, it all worked fine.

However, when pushing the documentation to GitHub Pages I experienced the same problem as you did, as you can see here

https://leif-ibsen.github.io/DocCTest/documentation/docctest