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.

Sign up for GitHub

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

Jump to bottom

SPM build manifest does not exist at .build/debug.yaml or does not match expected format. #71

Open
spnkr opened this issue Dec 10, 2021 · 3 comments
Open

SPM build manifest does not exist at .build/debug.yaml or does not match expected format. #71

spnkr opened this issue Dec 10, 2021 · 3 comments

Comments

@spnkr
Copy link

spnkr commented Dec 10, 2021

When I try to build docs for source docs, as shown in the readme, it doesn't work. On an M1 Mac.

Brief Description

% sourcedocs generate --spm-module SourceDocsDemo 
Processing SwiftPM module SourceDocsDemo...
SPM build manifest does not exist at `<redacted>/.build/debug.yaml` or does not match expected format.
Error: Error: Failed to generate documentation for SwiftPM module 'SourceDocsDemo'.

Steps to Reproduce

  1. Download tag 2.0 (or main)
  2. Unzip to folder SourceDocs-download
  3. cd SourceDocs-download
  4. sourcedocs generate --spm-module SourceDocsDemo
  5. Get error

Expected Outcome

It builds docs.

Actual Outcome

Error, no docs built

Environment

Xcode 13.1

MacBook Pro M1

swift-driver version: 1.26.9 Apple Swift version 5.5.1 (swiftlang-1300.0.31.4 clang-1300.0.29.6)
Target: arm64-apple-macosx12.0

Mac OS 12.0.1

SourceDocs v2.0.0

Additional Comments

Demo Project

Using the main repo's demo project
@eneko
Copy link
Collaborator

eneko commented Dec 15, 2021 •
edited
Loading

Hi @spnkr, apologies, the documentation is misleading. The package has to be built beforehand for SourceDocs to work.

Please run:

  • swift package build
  • sourcedocs generate <your params>

If that still doesn't work, please let me know. Thank you!

@spnkr
Copy link
Author

spnkr commented Dec 16, 2021 

> swift package build
error: Unexpected argument 'build'

Hmm, any ideas @eneko?

Tried with rosetta and without:

swift-driver version: 1.26.9 Apple Swift version 5.5.1 (swiftlang-1300.0.31.4 clang-1300.0.29.6)
Target: arm64-apple-macosx12.0

Apple Swift version 5.5.1 (swiftlang-1300.0.31.4 clang-1300.0.29.6)
Target: x86_64-apple-macosx12.0

@eneko
Copy link
Collaborator

eneko commented Dec 16, 2021

Oh my, I meant to write swift build. Sorry, that should work 🙏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@spnkr @eneko