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 cannot generate the documentation folder #29

Open
hamed8080 opened this issue Sep 21, 2022 · 6 comments
Open

Docc cannot generate the documentation folder #29

hamed8080 opened this issue Sep 21, 2022 · 6 comments
Labels
bug Something isn't working

Comments

@hamed8080
Copy link

Docc plugin is not able to generate the documentation folder for the target.

Checklist

I'm using the main branch before I was using 1.0.0

Expected behavior

Generate documentation folder.

Actual behavior

It finds my docc file but when I go to the archive folder there is no documentation which is the reason why I can't see the documentation correctly. I tested it with a custom symbol graph and it works but I'm not sure this plugin support graph. But It generates some simple package that I write!

Steps to Reproduce

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

Swift-DocC Plugin Version Information

Swift-DocC plugin version: 1.0.0 and main commit hash.
3303b16 , 6a6577a

Swift Compiler version: Output from swiftc --version.
swift-driver version: 1.62.8 Apple Swift version 5.7 (swiftlang-5.7.0.127.4 clang-1400.0.29.50)
Target: x86_64-apple-macosx12.0

@hamed8080 hamed8080 added the bug Something isn't working label Sep 21, 2022
@ethan-kusters
Copy link
Collaborator

Thanks for opening this @hamed8080 – do you have an example Swift package that reproduces this issue?

@lukepistrol
Copy link

I can confirm this!

In https://github.com/CodeEditApp/CodeEditLanguages it does not work.

@lukepistrol
Copy link

Also on https://github.com/CodeEditApp/CodeEditTextView it does no longer work. It did a couple months ago.

@lukepistrol
Copy link

A workaround I found worked well is using the xcodebuild docbuild command:

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

wangzhizhou pushed a commit to wangzhizhou/DebugSettings that referenced this issue Nov 23, 2022
@wangzhizhou
Copy link

This bug exist in 1.0.0,and the xcodebuild docbuild command worked! Thank you @lukepistrol

@SpectralDragon
Copy link

Hi there! Same trouble in https://github.com/AdaEngine/AdaEngine

Any help?

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

No branches or pull requests

5 participants