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

🐞 [DocC]: Documentation Not Generated #1

Closed
lukepistrol opened this issue Oct 29, 2022 · 1 comment · Fixed by #6
Closed

🐞 [DocC]: Documentation Not Generated #1

lukepistrol opened this issue Oct 29, 2022 · 1 comment · Fixed by #6
Labels
bug Something isn't working documentation Improvements or additions to documentation help wanted Extra attention is needed

Comments

@lukepistrol
Copy link
Member

The documentation of CodeEditLanguages is not generated properly. Not locally and not on our CI. Using Xcode to build it works though.

Terminal command

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

Expected Result

After completion a docs directory should be created. Inside this folder a directory called documentation should be created.

Actual Result

There is a docs directory.
There is NO documentation directory inside.

@lukepistrol lukepistrol added bug Something isn't working documentation Improvements or additions to documentation help wanted Extra attention is needed labels Oct 29, 2022
@lukepistrol lukepistrol linked a pull request Nov 12, 2022 that will close this issue
@lukepistrol
Copy link
Member Author

What fixed the issue?

The problem was that, for some reason, the above mentioned command did not produce a documentation folder anymore. It though works on a brand new package. I could not debug what exactly the issue was but it also seems to happen on CodeEditTextView.

The workaround I found was using the following xcodebuild command:

xcodebuild docbuild -scheme CodeEditLanguages \
    -destination generic/platform=macos \
    OTHER_DOCC_FLAGS="--transform-for-static-hosting --hosting-base-path CodeEditLanguages --output-path ./docs"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation help wanted Extra attention is needed
Projects
Status: 🏁 Complete
Development

Successfully merging a pull request may close this issue.

1 participant