Installation instructions fail for 2.5.2 #718
Assignees
Comments
|
The DNX version of docfx is already replaced by .NET Core version. I'll update the documentation soon. Thanks. |
Merged
|
Hello, I've been struggling for hours to make this work on mac osx. But I can't find a solution my self. I've succeed in installing ASP.NET, dnvm/dnx. I've pushed the required feed url as explained on the README. But the command I've noticed that the package has been downloaded to I've tested various A little bit of help would be much appreciated ! I'm just trying to make the docfx-seed example project working at the moment. Thanks a lot, MBP-de-Lionel:docfx-seed Lionel$ nuget sources add -name docfxfeed -source https://www.myget.org/F/aspnetrelease/api/v2/
Added file 'NuGet.Config' to folder '/Users/Lionel/.config/NuGet'.
Added file 'NuGet.Config' to folder '/Users/Lionel/.config/NuGet'.
Source de package avec nom : docfxfeed ajouté correctement.
MBP-de-Lionel:docfx-seed Lionel$ dnu commands install docfx
Microsoft .NET Development Utility Mono-x64-1.0.0-rc1-16609
GET https://www.nuget.org/api/v2/
OK https://www.nuget.org/api/v2/ 700ms
CACHE https://www.myget.org/F/aspnetrelease/api/v2/
CACHE https://api.nuget.org/v3/index.json
GET https://www.nuget.org/api/v2/FindPackagesById()?id='docfx'
CACHE https://www.myget.org/F/aspnetrelease/api/v2/FindPackagesById()?id='docfx'
CACHE https://api.nuget.org/v3-flatcontainer/docfx/index.json
OK https://www.nuget.org/api/v2/FindPackagesById()?id='docfx' 301ms
CACHE https://www.nuget.org/api/v2/
CACHE https://www.myget.org/F/aspnetrelease/api/v2/
CACHE https://api.nuget.org/v3/index.json
Restoring packages for /Users/Lionel/.dnx/bin/packages/c24437d23c3f4ecd82acc66c4aa2cfb8/project.json
Writing lock file /Users/Lionel/.dnx/bin/packages/c24437d23c3f4ecd82acc66c4aa2cfb8/project.lock.json
Restore complete, 206ms elapsed
NuGet Config files used:
/Users/Lionel/.config/NuGet/nuget.config
Feeds used:
https://www.nuget.org/api/v2/
https://www.myget.org/F/aspnetrelease/api/v2/
https://api.nuget.org/v3-flatcontainer/
The specified package is not an application. The package was added but no commands were installed.
MBP-de-Lionel:docfx-seed Lionel$ dnvm list
Active Version Runtime Architecture OperatingSystem Alias
------ ------- ------- ------------ --------------- -----
1.0.0-rc1-update1 clr x64 win
1.0.0-rc1-update1 coreclr x64 darwin
1.0.0-rc1-update1 coreclr x64 win
1.0.0-rc1-update1 mono linux/osx
* 1.0.0-rc1-update2 mono linux/osx defaultNuget Config file <?xml version="1.0" encoding="utf-8"?>
<configuration>
<packageSources>
<add key="https://www.nuget.org/api/v2/" value="https://www.nuget.org/api/v2/" />
<add key="docfxfeed" value="https://www.myget.org/F/aspnetrelease/api/v2/" />
<add key="nuget.org" value="https://api.nuget.org/v3/index.json" protocolVersion="3" />
</packageSources>
</configuration> |
|
@lionpeloux , DocFX only support .NET Core currently since DNX is deprecated. If you want run DocFX on macOS, you can download the released package and run it with Mono. |
|
Hi quiezh. Thanks for answering. So I've tried your recommendations. |
|
I've also tried to build the sources (master branch up to date from github) with xbuild but it failed to ... |
|
Ok, I've managed to make it work. I wasn't using the command line properly.
Maybe this few lines could be added to the readme or startup guidelines as they might help people setting up this great tool ?? |
|
Thanks @lionpeloux , the guidelines is helpful for others, I'll add it later. Actually, what we hope is to run DocFX on macOS or Linux without mono, but it requires DocFX target on .NET Core standard framework. However, due to some dependency(like GitSharp), we have to target DocFX on net45 framework...Maybe we'll remove these dependency someday to make DocFX support cross platform without mono. |
Closed
|
You should probably mention the minimum version of mono needed. I had 3.x installed and it didn't work. 5.x did though |
|
@vicancy Seems we need to verify it and update the documentation? |
|
Hm. What am I missing here?
|
|
@SeaDude |
|
When you click "Download .Zip" from the docfx-seed repo, it downloads a .zip file called "docfx-seed-master".
|
|
@SeaDude |
|
@SeaDude any update? |
|
I was able to get this running. I'm not sure exactly what changed. Here is what I did:
|
@SeaDude You can try |
|
Aha. Thank you for that tip. This is my first time using the tool! |
|
I know this is nearly a year to the day later, but...
Seems like I can only get |
|
It has not this constraint. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
The getting started docs for using docfx from DNX include:
That manages to find v2.5.2, but fails at the end with:
(Nothing is added to the
dnx\packages\docfxdirectory as far as I can see.)Presumably this is due to phasing out the DNX branch entirely, but it would be worth removing the non-working instructions (and ideally replacing them with working ones...)
Using the zip file from 2.5.2 works to some extent, although it's throwing an exception which I'll report separately...
The text was updated successfully, but these errors were encountered: