Skip to content

Loading…

Xcode got an error: No documentation set present at specified path. #141

Closed
rogmabi opened this Issue · 15 comments

5 participants

@rogmabi

I followed the quick install guide, read troubleshooting section but did not find how to solve this error. If anyone can help it would be highly appreciated.

Error log :

INFO | Installing DocSet...
Generation step 3/3 failed: GBDocSetInstallGenerator failed generaing output, aborting!
Documentation set was installed, but couldn't reload documentation within Xcode.
Xcode got an error: No documentation set present at specified path.

Thanks,

@tomaz
Owner

This error suggests there was some issue with reloading documentation within Xcode. You can increase verbosity level to 5 or 6 and run again, then check for line "VERBOSE | Moving DocSet files from" just below "INFO | Installing DocSet..." - it'll tell you the location where appledoc has copied/moved docset. Then check that location for docset bundle - the error says that Xcode doesn't find it there.

@rogmabi

Thanks tomaz. Here is the new log output (verbose set to 6), output set to /Users/Moi/Library/Developer/Shared/Documentation/DocSets

INFO | Installing DocSet...
VERBOSE | GBDocSetInstallGenerator is generating output...
VERBOSE | Moving DocSet files from '/Users/Moi/Library/Developer/Shared/Documentation/DocSets/docset' to '/var/root/Library/Developer/Shared/Documentation/DocSets/com.yamm.rentlocallytest.RentlocallyTest.docset'...
VERBOSE | Initializing directory at '/var/root/Library/Developer/Shared/Documentation/DocSets/com.yamm.rentlocallytest.RentlocallyTest.docset'...
DEBUG | Removing existing directory...
DEBUG | Creating directory...
DEBUG | Moving '/Users/Moi/Library/Developer/Shared/Documentation/DocSets/docset' to '/var/root/Library/Developer/Shared/Documentation/DocSets/com.yamm.rentlocallytest.RentlocallyTest.docset'...
DEBUG | Removing '/var/root/Library/Developer/Shared/Documentation/DocSets/com.yamm.rentlocallytest.RentlocallyTest.docset'...
VERBOSE | Installing DocSet to Xcode...
Generation step 3/3 failed: GBDocSetInstallGenerator failed generaing output, aborting!
Documentation set was installed, but couldn't reload documentation within Xcode.
Xcode got an error: No documentation set present at specified path.
INFO | Finished generating in 1377ms.

NORMAL | Finished in 5131ms.
INFO | Parsing: 2235ms (43%)
INFO | Processing: 1519ms (29%)
INFO | Generating: 1377ms (26%)
DEBUG | Exiting with result 2 (reported result was 2)...

Any idea how to solve this ?

I am running Xcode 4.1 for Lion 10.7.1.

Thanks,

@tomaz
Owner

The folder used for installing docset looks strange (var/root/Library/Developer/Shared/Documentation/DocSets), it should default to ~/Library/Developer/Shared/Documentation/DocSets. Are you using --docset-install-path (either cmd line, or in global or project settings file - you can verify with --print-settings cmd line switch)? If not, add the setting to the correct path.

@tomaz tomaz closed this
@rogmabi

Thanks tomaz, it worked after setting the parameter --docset-install-path to the default ~/Library/Developer/Shared/Documentation/DocSets in the cmd line.

@rogmabi

Is there a link to this documentation http://cl.ly/1v020O3i2M0R0B2D453S in the github README ? Would be useful.

@tomaz
Owner

Kind of - there's link to appledoc's main page and it contains the link to online docs there. The page is a single paragraph + license, so I thought it should be visible enough :) But I agree on adding it to readme too...

@rogmabi

btw, it's a fantastic tool! I am planning to use it on most of my projects. Thanks for all your kind and quick answers and have a nice day!

@khansensf

Make sure that you have not renamed Xcode. I routinely add the version into the app name so it is easier to keep multiple versions in the dock. e.g. /Developer/Applications/Xcode4.2.1.app instead of /Developer/Applications/Xcode.app. This causes the applescript GBDocSetInstallGenerator to fail because it cannot find appledoc.

I was able to easily solve this by using a softlink to Xcode.app for placing in the dock.
cd /Developer/Applications
sudo ln -s Xcode.app Xcode4.2.1.app

Unlikely to be a common error - but I thought worth noting...

@tomaz
Owner

Thanks for info. Your error might come from apple script informing Xcode about to reload doc sets. Not sure if it works for Xcode 4 anyway, at least doesn't seem to for me...

@khansensf

The error was from the applescript. I ran it interactively in the AppleScript editor and saw that it could not find XCode.

This is in now way an issue with appledoc, but with the odd way I setup my environment. But I know some other developments who use the same technique to move between versions of Xcode while Apple is beta'ing a major rev. It may be worth noting in a FAQ, but I don't feel it requires a solution in code.

@tomaz
Owner

Even more, looking at the code, the Apple Script doesn't invoke any special Xcode version. Am not so much at home with Apple Script to know by heart whether it accepts direct path to an app or it simply derives it internally. Mentioning in FAQ would be smart though, will do it when I get to it...

@flofly

Good evening,

I try to use applecode but I have the same problem. Firstly, in order to install correctly applecode I changed the file install-appledoc.sh, I replace "BINARY_DIR=/usr/local/bin/" by "BINARY_DIR=/usr/bin/" to fix a problem at installation. Once appledoc installed I tryed to test him with this command :

appledoc --project-name "Calculator" --project-company "Test" --company-id "com.test" --output ~/help .

I had this error :

Generation step 3/3 failed: GBDocSetInstallGenerator failed generaing output, aborting!
Documentation set was installed, but couldn't reload documentation within Xcode.
Xcode got an error: No documentation set present at specified path.

The same problem that rogmabi.

So I tried this command :

appledoc --project-name "Calculator" --project-company "Test" --company-id "com.test" --verbose 6 --output ~/help .

and the logs are :

VERBOSE | Moving DocSet files from '/var/root/help/docset' to '/var/root/Library/Developer/Shared/Documentation/DocSets/com.test.Calculator.docset'...

So I tried the solution proposed with this command :

appledoc --project-name "Calculator" --project-company "Test" --company-id "com.test" --output ~/help --docset-install-path ~/Library/Developer/Shared/Documentation/DocSets .

But I have yet this message :

Generation step 3/3 failed: GBDocSetInstallGenerator failed generaing output, aborting!
Documentation set was installed, but couldn't reload documentation within Xcode.
Xcode got an error: No documentation set present at specified path.

So have you got a solution ?

@tomaz
Owner

The paths /var/root from log seem strange. Besides that, did you get some docs actually generated? You can test by displaying contents of generated DocSet and look inside for html files - open index.html for example and you should have at least one link to a class/category/protocol in there.

@flofly

Good evening,

So, after execution of this command :
appledoc --project-name "Calculator" --project-company "Test" --company-id "com.test" --verbose 6 --output /Users/floriancourtial/Desktop/ .
Into
/Users/floriancourtial/Desktop/
I have a file
docset-installed.txt ,
in this there is :


Documentation set was installed to Xcode!
Path: /var/root/Library/Developer/Shared/Documentation/DocSets/com.test.Calculator.docset
Time: 2013-03-19 17:45:28 +0000

whereas I have yet this error :


Documentation set was installed, but couldn't reload documentation within Xcode.
Xcode got an error: No documentation set present at specified path.
INFO | Finished generating in 2389ms.

But if I go into :
/var/root/Library/Developer/Shared/Documentation/DocSets/com.test.Calculator.docset
I have the html documentation.

For this moment I just want HTML documentation. I will create an AppleScript and a generate_appledoc.sh. I must to learn more about applecode argument.

If I fix my docset problem I'll say you.

Thank you for all.

@program247365

For me, the solutions was to do:

outputPath="${PROJECT_DIR}/Documentation";

And in my .gitignore

/Documentation

Plain and simple, and I no longer got the errors with the default '~/help' path.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.