Skip to content
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

Error when publishing to GitHub Pages #820

Open
1 of 2 tasks
leif-ibsen opened this issue Feb 9, 2024 · 7 comments
Open
1 of 2 tasks

Error when publishing to GitHub Pages #820

leif-ibsen opened this issue Feb 9, 2024 · 7 comments
Labels
bug Something isn't working needs more information Further information is requested

Comments

@leif-ibsen
Copy link

leif-ibsen commented Feb 9, 2024

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 leif-ibsen added the bug Something isn't working label Feb 9, 2024
@leif-ibsen
Copy link
Author

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
Copy link
Author

leif-ibsen commented Feb 15, 2024

The error occurs when you click the following operators:

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

The following operators work ok:

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

@leif-ibsen
Copy link
Author

leif-ibsen commented Feb 27, 2024

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 d-ronnqvist added the needs more information Further information is requested label Mar 8, 2024
@d-ronnqvist
Copy link
Contributor

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
Copy link
Author

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
Copy link
Author

leif-ibsen commented Apr 3, 2024 via email

@leif-ibsen
Copy link
Author

leif-ibsen commented Aug 7, 2024

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:

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working needs more information Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants