API Docs

[tincboy]

I've tried link below to build FreeNAS API docs, but there are many issue which make it imposible
first the packages are py27 not py, and second the py27-sphinxcontrib-httpdomain has many failed dependencies which make it impossible to have FreeNAS API
http://doc.freenas.org/index.php/Section_5:_Using_the_FreeNAS®_API
Is there any way to fix those errors? anyone tried it yet? or anyone kind to make a download link of API docs?

 

[tincboy]

No one has the documents of API yet?

 

[cyberjock]

AFAIK the FreeNAS manual chapter 16 is the only API stuff we currently have.

 

[Cymike]

I'm putting a new build server up for myself and will be trying this out soon. Can you post more detail/error logs and the uname -a of the system where you're trying to build from?

 

[warri]

Worked for me with Arch Linux: "Linux x220-arch 3.14.1-1-ARCH #1 SMP PREEMPT Mon Apr 14 20:40:47 CEST 2014 x86_64 GNU/Linux". I needed to install python-sphinx and python-sphinxcontrib-httpdomain from AUR.

If you still need docs, I can upload them somewhere.

 

[Cymike]

Warri - thanks for the input. Curious that you were able to build them out on linux! I wonder how many others have done so. As for uploading the docs, I will see about getting something more official posted. No promises though, as I'm not sure what the available options for that are right now.

 

[bigphil]

I too have had issues getting the API docs to load correctly into the system. I think the instructions referenced in the OP need to be re-worked. I was able to get the files I needed (iSCSI-index.rst) but I couldn't get the webserver to run to view them...I have to copy the file out and view it with a text editor. Same issues with py as the OP.

 

[warri]

After 'make html' you should end up with a bunch of HTML documents, viewable in any browser without web server.

You did not specify your system, but have you tried using pip to manage your python dependencies?

 

[bigphil]

Ahhhh...I think that is where I might have went wrong (maybe the OP too). I was trying to build the "local copy" on the FreeNAS box...not a different system ;-)

 

[warri]

Correct, I doubt that this is going to work, since the FreeNAS installation only contains a minimal set of dependencies.

The guide in the wiki refers to FreeBSD 9.2 (using pkg_add), while I successfully built the docs on a Linux machine (in my case, installing the dependencies over the Arch repositories). If your package manager does not provide the additional python dependencies, just install python2 and pip (a python-based package manager). You should then be able to install Sphinx and sphinxcontrib-httpdomain via pip.

 

[Cymike]

I'm going to try uploading my recently compiled docs in both html and text here. Toss me some feedback whether these work for you or not please. Also as cyberjock noted, there is still Chapter 16 of the manual for reference as well. Thanks!