Yii Framework Forum: Yii Docs: Generate Docs For Api, Guide And Blog (Chm Compartible) - Yii Framework Forum

Jump to content

Page 1 of 1
  • You cannot start a new topic
  • You cannot reply to this topic

Yii Docs: Generate Docs For Api, Guide And Blog (Chm Compartible) Rate Topic: -----

#1 User is offline   Stefano Mtangoo 

  • Standard Member
  • PipPip
  • Yii
  • Group: Members
  • Posts: 145
  • Joined: 02-January 12
  • Location:Dar es Salaam, Tanzania

Posted 02 January 2013 - 03:37 PM

Hi,
I have in-house IDE I use with Yii and I want to make integration with Yii Manuals (API, Guide and Blog). All I need is un-compiled CHM files (html/css/js and .hhp .hhk and .hhc). I tried with Guide and all I can get is latex files. So is with blog. I did not get API generate files (see error log below.)

My question is, is it possible to get that with Yii. I got it when compiling PHP Manual's docbook XML.
I don't understand much of Yii docs so sorry if it is something obvious

And If I posted in inappropriate place, I apologize.

Stefano

Quote

~/Desktop/yii-master$ ./build/build api check yiidocs/
Checking PHPDoc @param in source files ...
ERROR.............: Documentation not found!
Source file.......: /home/stefano/Desktop/yii-master/framework/db/schema/mssql/CMssqlSqlsrvPdoAdapter.php
Parameter line....: 30
Parameter name....: $sequence

ERROR.............: Documentation not found!
Source file.......: /home/stefano/Desktop/yii-master/framework/logging/CLogger.php
Parameter line....: 132
Parameter name....: $except

ERROR.............: Documentation not found!
Source file.......: /home/stefano/Desktop/yii-master/framework/logging/CLogger.php
Parameter line....: 183
Parameter name....: $index

ERROR.............: Documentation not found!
Source file.......: /home/stefano/Desktop/yii-master/framework/utils/CFileHelper.php
Parameter line....: 280
Parameter name....: $recursive

ERROR.............: Documentation not found!
Source file.......: /home/stefano/Desktop/yii-master/framework/utils/CFormatter.php
Parameter line....: 203
Parameter name....: $time

ERROR.............: Documentation not found!
Source file.......: /home/stefano/Desktop/yii-master/framework/validators/CEmailValidator.php
Parameter line....: 187
Parameter name....: $value

ERROR.............: Documentation not found!
Source file.......: /home/stefano/Desktop/yii-master/framework/validators/CUrlValidator.php
Parameter line....: 167
Parameter name....: $value

ERROR.............: Documentation not found!
Source file.......: /home/stefano/Desktop/yii-master/framework/validators/CUrlValidator.php
Parameter line....: 180
Parameter name....: $value

ERROR.............: Documentation not found!
Source file.......: /home/stefano/Desktop/yii-master/framework/web/widgets/captcha/CCaptcha.php
Parameter line....: 164
Parameter name....: $extension

Done.

And God said, Let there be science...and it was so!
Training Manager Written in Yii here
0

#2 User is offline   jacmoe 

  • Elite Member
  • Yii
  • Group: Moderators
  • Posts: 2,601
  • Joined: 10-October 10
  • Location:Denmark

Posted 02 January 2013 - 03:59 PM

Looking at the Phing build script -> https://github.com/y...build/build.xml

you need the help compiler (hhc) in your path.
And then of course Phing and phpdoc.

Did you use phing?
"Less noise - more signal"
0

#3 User is offline   Stefano Mtangoo 

  • Standard Member
  • PipPip
  • Yii
  • Group: Members
  • Posts: 145
  • Joined: 02-January 12
  • Location:Dar es Salaam, Tanzania

Posted 03 January 2013 - 03:50 AM

Hi Jacmoe,

View Postjacmoe, on 02 January 2013 - 03:59 PM, said:

Looking at the Phing build script -> https://github.com/y...build/build.xml

you need the help compiler (hhc) in your path.


I don't thinks so, because I don't need to compile them in chm. So that final step is unnecessary unless it is compulsory to make the script run. I'm working from Ubuntu with no hhc compiler (I don't need CHM but the files that are finally compiled into CHM)

View Postjacmoe, on 02 January 2013 - 03:59 PM, said:

And then of course Phing and phpdoc.


How do I install phpdoc? Pear or something like that? Is it necessary to do the build?

View Postjacmoe, on 02 January 2013 - 03:59 PM, said:

Did you use phing?


What is it? That script in build directory?
If so then Yes. Actually what I did was downloading the archive from github extracted and CD-ed to that directory
then on terminal i typed:

./build/build api check yiidocs/

And God said, Let there be science...and it was so!
Training Manager Written in Yii here
0

#4 User is offline   Stefano Mtangoo 

  • Standard Member
  • PipPip
  • Yii
  • Group: Members
  • Posts: 145
  • Joined: 02-January 12
  • Location:Dar es Salaam, Tanzania

Posted 03 January 2013 - 04:10 AM

I have read what phing is and installed it. But it is only a PDF generator.
I need HTMLHelp project files (just before they are compiled into chm)
I'm still searching for possibility but I remember docs in version 1.9 I think had a CHM file so it should be possible somewhere down the road!
And God said, Let there be science...and it was so!
Training Manager Written in Yii here
0

#5 User is offline   Stefano Mtangoo 

  • Standard Member
  • PipPip
  • Yii
  • Group: Members
  • Posts: 145
  • Joined: 02-January 12
  • Location:Dar es Salaam, Tanzania

Posted 03 January 2013 - 04:39 AM

I have read this paper and its promising but the latex2html in Ubuntu requires like 0.5GB, quiet huge (with dependencies of course). Is there a light solution out there?

Also I cannot get API build. I have tried as log above shows. But I have tried to remove Guide and Blog from build.xml and leave API alone but it builds empty archive in build/release/dist. What am I doing wrong?
And God said, Let there be science...and it was so!
Training Manager Written in Yii here
0

#6 User is offline   Stefano Mtangoo 

  • Standard Member
  • PipPip
  • Yii
  • Group: Members
  • Posts: 145
  • Joined: 02-January 12
  • Location:Dar es Salaam, Tanzania

Posted 07 January 2013 - 03:55 AM

View PostStefano Mtangoo, on 03 January 2013 - 04:39 AM, said:

I have read this paper and its promising but the latex2html in Ubuntu requires like 0.5GB, quiet huge (with dependencies of course). Is there a light solution out there?

Also I cannot get API build. I have tried as log above shows. But I have tried to remove Guide and Blog from build.xml and leave API alone but it builds empty archive in build/release/dist. What am I doing wrong?

Help Please :bump:
And God said, Let there be science...and it was so!
Training Manager Written in Yii here
0

#7 User is offline   Stefano Mtangoo 

  • Standard Member
  • PipPip
  • Yii
  • Group: Members
  • Posts: 145
  • Joined: 02-January 12
  • Location:Dar es Salaam, Tanzania

Posted 07 January 2013 - 12:24 PM

View PostStefano Mtangoo, on 07 January 2013 - 03:55 AM, said:

Help Please :bump:

I can build API now (it needs PHPUnit and Selenium ext). It contains MS Help Project files which is fine.

I want to have now MS Project files. I have downloaded and installed latex2html and I'm trying it out!

Any help is appreciated (for Guide and Blog)
And God said, Let there be science...and it was so!
Training Manager Written in Yii here
1

#8 User is offline   jacmoe 

  • Elite Member
  • Yii
  • Group: Moderators
  • Posts: 2,601
  • Joined: 10-October 10
  • Location:Denmark

Posted 07 January 2013 - 12:27 PM

Stefano: I can't help you because I haven't done this, and don't need it, and don't have time to look into it..

But, I would really appreciate if you started a wiki page about how to actually do this.

Great job so far. :)
"Less noise - more signal"
0

#9 User is offline   Stefano Mtangoo 

  • Standard Member
  • PipPip
  • Yii
  • Group: Members
  • Posts: 145
  • Joined: 02-January 12
  • Location:Dar es Salaam, Tanzania

Posted 07 January 2013 - 04:14 PM

View Postjacmoe, on 07 January 2013 - 12:27 PM, said:

Stefano: I can't help you because I haven't done this, and don't need it, and don't have time to look into it..

But, I would really appreciate if you started a wiki page about how to actually do this.

Great job so far. :)

Thanks for word of encouragement.
If I succeed I will write full wiki. Else I will post my little success!
And God said, Let there be science...and it was so!
Training Manager Written in Yii here
1

#10 User is offline   Stefano Mtangoo 

  • Standard Member
  • PipPip
  • Yii
  • Group: Members
  • Posts: 145
  • Joined: 02-January 12
  • Location:Dar es Salaam, Tanzania

Posted 07 January 2013 - 05:54 PM

How does Yii docs generate online version of the user Guide and Blog tutorial?
If anyone knows, I would appreciate!
And God said, Let there be science...and it was so!
Training Manager Written in Yii here
0

#11 User is offline   Stefano Mtangoo 

  • Standard Member
  • PipPip
  • Yii
  • Group: Members
  • Posts: 145
  • Joined: 02-January 12
  • Location:Dar es Salaam, Tanzania

Posted 10 January 2013 - 03:23 PM

View PostStefano Mtangoo, on 07 January 2013 - 05:54 PM, said:

How does Yii docs generate online version of the user Guide and Blog tutorial?
If anyone knows, I would appreciate!


Anyone who knows how I can get HTML version of Guide and Blog tutorial?
And God said, Let there be science...and it was so!
Training Manager Written in Yii here
0

#12 User is offline   Stefano Mtangoo 

  • Standard Member
  • PipPip
  • Yii
  • Group: Members
  • Posts: 145
  • Joined: 02-January 12
  • Location:Dar es Salaam, Tanzania

Posted 11 January 2013 - 07:44 AM

bump :)
And God said, Let there be science...and it was so!
Training Manager Written in Yii here
0

#13 User is offline   Stefano Mtangoo 

  • Standard Member
  • PipPip
  • Yii
  • Group: Members
  • Posts: 145
  • Joined: 02-January 12
  • Location:Dar es Salaam, Tanzania

Posted 22 January 2013 - 07:07 AM

related https://github.com/y...yii/issues/1950
And God said, Let there be science...and it was so!
Training Manager Written in Yii here
0

Share this topic:


Page 1 of 1
  • You cannot start a new topic
  • You cannot reply to this topic

1 User(s) are reading this topic
0 members, 1 guests, 0 anonymous users