CodeIgniter Forums
.Epub file for CodeIgniter 3 User Manual - Printable Version

+- CodeIgniter Forums (https://forum.codeigniter.com)
+-- Forum: Using CodeIgniter (https://forum.codeigniter.com/forumdisplay.php?fid=5)
+--- Forum: General Help (https://forum.codeigniter.com/forumdisplay.php?fid=24)
+--- Thread: .Epub file for CodeIgniter 3 User Manual (/showthread.php?tid=1582)

.Epub file for CodeIgniter 3 User Manual - SlimG - 03-23-2015

I compiled the CodeIgniter 3 User Manual for my own use.

I've linked to it here for whoever else would like to read their CodeIgniter on their e-reader devices.
Download link -> http://bit.ly/codeigniter3epub

I take no credit beyond the six commands I ran to compile it in Ubuntu 14.10 Wink

Here are instructions for those who are interested in compiling their own .epub instead of downloading the compiled one from the link above:
Code:
sudo apt-get install git python-sphinx python-sphinxcontrib.phpdomain
git clone --branch develop https://github.com/bcit-ci/CodeIgniter.git
cd CodeIgniter/user_guide_src/cilexer
sudo python setup.py install
cd ..
make epub

The resulting epub will be located in build/epub/CodeIgniter.epub

You can replace "epub" in the last command with one of the following if you prefer another output format:
  • html       to make standalone HTML files
  • dirhtml    to make HTML files named index.html in directories
  • singlehtml to make a single large HTML file
  • pickle     to make pickle files
  • json       to make JSON files
  • htmlhelp   to make HTML files and a HTML help project
  • qthelp     to make HTML files and a qthelp project
  • devhelp    to make HTML files and a Devhelp project
  • epub       to make an epub
  • latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter
  • latexpdf   to make LaTeX files and run them through pdflatex
  • text       to make text files
  • man        to make manual pages
  • changes    to make an overview of all changed/added/deprecated items
  • linkcheck  to check all external links for integrity
  • doctest    to run all doctests embedded in the documentation (if enabled)

My hat off to whoever wrote the manual, the content is of high quality, and the choice of using sphinx was genius! Smile

RE: .Epub file for CodeIgniter 3 User Manual - twpmarketing - 03-23-2015

Thank you for the very succinct method of generating the user manual.
And congrats on using Linux too...

RE: .Epub file for CodeIgniter 3 User Manual - Mel9pr - 03-23-2015

For some reason I get an error with this line "sudo python cilexer/setup.py install".

So I removed it and it work like a charm on ubuntu 14.04.

Great contribution for linux users.

Thank You!

RE: .Epub file for CodeIgniter 3 User Manual - SlimG - 03-23-2015

(03-23-2015, 10:37 AM)Mel9pr Wrote: For some reason I get an error with this line "sudo python cilexer/setup.py install".

Try to replace that line with this:
Code:
cd cilexer
sudo python setup.py install
cd ..


RE: .Epub file for CodeIgniter 3 User Manual - Avenirer - 03-24-2015

Great job. A lot of people were asking for this.

RE: .Epub file for CodeIgniter 3 User Manual - SlimG - 03-24-2015

I've corrected a few mistakes in the code-snippet

RE: .Epub file for CodeIgniter 3 User Manual - ciadmin - 03-24-2015

I will build an epub format user guide, and add a download link for it, with the next main website update.
Thank you, SlimG Smile

RE: .Epub file for CodeIgniter 3 User Manual - SlimG - 03-24-2015

My pleasure Smile Merely unlocking what was already prepared.

RE: .Epub file for CodeIgniter 3 User Manual - SlimG - 03-25-2015

Seems like the .epub download-link did not work, I've replaced it with one that does:
http://bit.ly/codeigniter3epub

RE: .Epub file for CodeIgniter 3 User Manual - alkarim - 04-23-2015

Great job...will take it for future works.