gdSc @ s
d Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l Z d d l m Z y d d l m Z Wn; e
k
r y d d l Z Wq e
k
r d Z q Xn Xd d l m
Z
d d l m Z d d l m Z d d l m Z m Z m Z d d l m Z d d
l m Z d Z d Z d
Z d Z d Z d Z d Z! d Z" d Z# d Z$ d Z% d Z& d Z' d Z( d Z) d Z* d Z+ i d d 6d d 6Z, i d d! 6d" d# 6d$ d% 6d& d' 6d( d) 6d* d+ 6d* d, 6d- d. 6d/ d0 6Z- d4 Z. e j/ d1 Z0 d2 e f d3 YZ1 d S(5 s
sphinx.builders.epub
~~~~~~~~~~~~~~~~~~~~
Build epub files.
Originally derived from qthelp.py.
:copyright: Copyright 2007-2014 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
iN( t path( t Image( t nodes( t addnodes( t StandaloneHTMLBuilder( t ensuredirt copyfilet EEXIST( t sphinx_smarty_pants( t browns application/epub+zipu
u
%(title)s
%(navpoints)s
u %(indent)s
%(indent)s
%(indent)s %(text)s
%(indent)s
%(indent)s
%(indent)s s s
navPoint%du
%(lang)s
%(title)s
%(author)s
%(publisher)s
%(copyright)s
%(id)s
%(date)s
s >t "s "s 's '( t replace( R R ( ( s> /usr/local/lib/python2.7/site-packages/sphinx/builders/epub.pyt esc s c C s t | t j r | j d r | d } | j d sg | j d sg | j d sg | j d rk | S| j j d } x t d d d D]Z } t | | k r | j i | d
6| j
| d 6t | j
| j d 6 Pq q Wn& x# | j
D] } | j | | } q W| S( s> Collect section titles, their depth in the toc and the refuri.t refuris http://s https://s irc:s mailto:t classesi i it levelt text( t
isinstanceR t referencet has_keyt
startswitht parentt
attributest ranget _toctree_templatet appendR# t sspt astextt childrent get_refnodes( R t doctreet resultR$ R% R& t elem( ( s> /usr/local/lib/python2.7/site-packages/sphinx/builders/epub.pyR4 s !
c C s | j j | j j | d t d t } | j | g | _ t j | j j } | r | d 7} x& | j D] } | | d | d /usr/local/lib/python2.7/site-packages/sphinx/builders/epub.pyt get_toc s
c C s | j d i d d 6| j | j j d d 6t | j | j j | j j j d 6 x] t | j j D]I \ } } | j d i d d 6| j | d 6t | j | d 6 qp WxT | j j
D]F \ } } | j i d d 6| j | d 6t | j | d 6 q Wd S( sF Add the master_doc, pre and post files to a list of refnodes.
i i R& s .htmlR$ R' N( t insertR# R R< R1 R t titlesR2 t reversedt epub_pre_filest epub_post_filesR0 ( R R? t fileR' ( ( s> /usr/local/lib/python2.7/site-packages/sphinx/builders/epub.pyRA s ' c C s | | j d d S( s; Return a href/id attribute with colons replaced by hyphens.t :t -( R" ( R t prefixt fragment( ( s> /usr/local/lib/python2.7/site-packages/sphinx/builders/epub.pyt fix_fragment s c C s x | j t j D] } d | k rl t j | d } | rl | j | j d | j d | d /usr/local/lib/python2.7/site-packages/sphinx/builders/epub.pyt fix_ids s . !
t inlinec C s d } d } d } | d k r+ d S| d k rh | j t j d } | | \ } } d } n xr| j t j D]^}
|
j d d
} | j d s | j d s | j d
r{ | |
j k r{ |
j j |
d } | d k r>t i | d 6} t j
| | }
|
d j t |
j j
| |
q| d k rt | } | d 7} | | | } |
j j
| | | | | | } | j
| | | d d | d <| j | d d | d 7} qq{ q{ Wd S( s+ Add visible link targets for external linksc S s6 t j d } | j t j | | j | | S( s. Create a footnote_reference node with childrens [#]_( R t footnote_referenceR0 t Textt note_autofootnote_ref( t doct labelt footnote_ref( ( s> /usr/local/lib/python2.7/site-packages/sphinx/builders/epub.pyt make_footnote_ref0 s
c S sk t j | } t j } | j t j | | j | | j d t j d | | j | | S( s$ Create a footnote node with childreni RQ ( R t footnotet paragraphR0 R_ RE Rb t note_autofootnote( Ra Rb t uriRe t para( ( s> /usr/local/lib/python2.7/site-packages/sphinx/builders/epub.pyt
make_footnote7 s
c S s | j t j } | r? | d } | j | j j | d f Sxe | j t j D]Q } t | j d k rR | j d j t k rR | j | j j | d f SqR W| j t j
d } t j } | j t j t | j | | | j | d f S( sf Find or create a spot to place footnotes.
The function returns the tuple (parent, index).ii i (
RS R Re R, t indext rubrict lenR3 R2 t _footnotes_rubric_namet documentR0 R_ ( RX t fnst fnRY Ra t rub( ( s> /usr/local/lib/python2.7/site-packages/sphinx/builders/epub.pyt
footnote_spotA s
!
t noNRe i i R$ RQ s http:s https:s ftp:R] Rh R% RR RP ( RS R Ro R) R R+ R2 R, Rk t _link_target_templateR] R0 t _css_link_target_classRE t _footnote_label_templatet add_backref( R RX t show_urlsRd Rj Rs Ra t fn_spott fn_idxt nrRY Rh t idxt linkRb Rc Re ( ( s> /usr/local/lib/python2.7/site-packages/sphinx/builders/epub.pyt add_visible_links- s:
!
c C s6 | j | | j | | j j t j | | | S( s Write one document file.
This method is overwritten in order to fix fragment identifiers
and to add visible external links.
( R\ R R t epub_show_urlsR t write_doc( R t docnameR5 ( ( s> /usr/local/lib/python2.7/site-packages/sphinx/builders/epub.pyR r s
c
C s! x| D]\ } } x| D] \ } \ } } xf t | D]X \ } \ } } t j | }
|
r9 | | j |
j d |
j d f | | /usr/local/lib/python2.7/site-packages/sphinx/builders/epub.pyt fix_genindex| s 2 c C s t j | d } | t k S( s= Does the filename extension indicate a vector graphic format?i( R t splitextt _vector_graphics_extensions( R t filenamet ext( ( s> /usr/local/lib/python2.7/site-packages/sphinx/builders/epub.pyt is_vector_graphics s c C s5 t t j | j d x| j | j d t t | j D]} | j | } y" t j t j | j
| } Wn t k
r2| j | s | j
d t j | j
| f n y2 t t j | j
| t j | j d | Wq> t t f k
r+} | j
d t j | j
| | f q> Xq> n X| j j r`| j d k r`| j } q`n | j j d k r| j \ } } | j j } | | k r| | | } | j | | f t j } qn y# | j t j | j d | Wq> t t f k
r,} | j
d t j | j
| | f q> Xq> Wd S(
s Copy images using the PIL.
The method tries to read and write the files with the PIL,
converting the format and resizing the image if necessary/possible.
t _imagess copying images... s- cannot read image file %r: copying it insteads cannot copy image file %r: %st Pi s cannot write image file %r: %sN( R ( R R t joint outdirt status_iteratort imagesR Rm R t opent srcdirt IOErrorR t warnR t OSErrorR t epub_fix_imagest modet convertt epub_max_image_widtht sizet resizet BICUBICt save( R t srct destt imgt errt widtht heightt nwt nh( ( s> /usr/local/lib/python2.7/site-packages/sphinx/builders/epub.pyt copy_image_files_pil s>
"
! !# c C sq | j rm | j j s! | j j rW t sJ | j d t t | j qj | j qm t t | j n d S( s{ Copy image files to destination directory.
This overwritten method can use the PIL to convert image files.
s# PIL not found - copying image filesN(
R R R R R R t superR t copy_image_filesR ( R ( ( s> /usr/local/lib/python2.7/site-packages/sphinx/builders/epub.pyR s
s page.htmlc C sC | j d r# | j | d n t j | | | | | | d S( s Create a rendered page.
This method is overwritten for genindex pages in order to fix href link
attributes.
t genindext genindexentriesN( R+ R R t handle_page( R t pagenamet addctxt templatenamet outfilenamet event_arg( ( s> /usr/local/lib/python2.7/site-packages/sphinx/builders/epub.pyR s c C sw | j | j | j d | j | j d | j | j d | j | j d | j | j | j j d d S( s/ Create the metainfo files and finally the epub.t mimetypes META-INF/container.xmls content.opfs toc.ncxs .epubN( RD t build_mimetypeR t build_containert
build_contentt build_toct
build_epubR t
epub_basename( R ( ( s> /usr/local/lib/python2.7/site-packages/sphinx/builders/epub.pyt
handle_finish s
c C sU | j d | t j t j | | d d } z | j t Wd | j Xd S( s! Write the metainfo file mimetype.s writing %s file...t ws utf-8N( t infot codecsR R R t writet _mimetype_templatet close( R R t outnamet f( ( s> /usr/local/lib/python2.7/site-packages/sphinx/builders/epub.pyR s
!c C s | j d | t j | | } y t j t j | Wn( t k
rg } | j t k rh qh n Xt j
t j | | d d } z | j t Wd | j
Xd S( s0 Write the metainfo file META-INF/cointainer.xml.s writing %s file...R s utf-8N( R R R t ost mkdirR@ R t errnoR R R R t _container_templateR ( R R R Rq R R ( ( s> /usr/local/lib/python2.7/site-packages/sphinx/builders/epub.pyR s
!c C s i } | j | j j | d <| j | j j | d <| j | j j | d <| j | j j | d <| j | j j | d <| j | j j | d <| j | j j | d <| j | j j | d <| j t
j d | d
<| | d <| | d <| | d
<| S( sa Create a dictionary with all metadata for the content.opf
file properly escaped.
t titlet authort uidt langt publishert copyrightt schemeR s %Y-%m-%dt datet filest spinet guide( R# R t
epub_titlet epub_authort epub_uidt
epub_languaget epub_publishert epub_copyrightt epub_schemet epub_identifiert timet strftime( R R R R t metadata( ( s> /usr/local/lib/python2.7/site-packages/sphinx/builders/epub.pyt content_metadata s
c C s* | j d | | j t j s3 | t j 7} n t | } g } g | _ d d d d d | j j d g | j j | _ xt j
| D]\ } } } x | D] } t j | | | } | | j k r q n t j
| d }
|
t k r|
d# k r | j d | q q n | j t j d } | j t i | j | d
6| j | j | d 6| j t |
d 6 | j j | q Wq Wg } xn | j D]c } d | d k rqn | d | j k rqn | j t i | j | j | d d 6 qWxF | j D]; }
| j t i | j | j |
d | j d 6 qW| j d d r| j t i | j | j d | j d 6 n t } d" } | j j r3| j j \ } } | j t j d } | j d } | j d d | d } | | t i | j | j | d 6| | } | r3| j d t i | j | j t d 6 t | j k rt j
t d }
| j j t | j t i | j t d
6| j | j t d 6| j t |
d 6 n i | j | d 6| j j! d 6} | j" t j
t d | | q3n g } t# } t# } | j j$ rx | j j$ D] \ } } } | j% d d } | | j k r| j j | n | d k rt& } n | d k rt& } n | j t' i | j | d 6| j | d 6| j | d 6 q^Wn | rV| rV| j t' i d d 6t( d d 6| j t d 6 n | r| j r| j t' i d d 6t( d d 6| j | j d d d 6 n d j | } d j | } d j | } t) j* t j | | d d! } z$ | j+ | | j, | | | Wd" | j- Xd" S($ s Write the metainfo file content.opf It contains bibliographic data,
a file list and the spine (the reading order).
s writing %s file...s
.buildinfoR s content.opfs toc.ncxs META-INF/container.xmls .epubis .jss .xmls! unknown mimetype for %s, ignoringR: t hrefR t
media_typet #R$ t idrefi t use_indexR
R s s
i R t imageR R
t typeRh R s utf-8N( s .jss .xml(. R t endswithR t sepRm R R R t epub_exclude_filest
ignored_filest walkR R R t _media_typesR R" R0 t _file_templateR# R R? t _spine_templatet domain_indicesR t get_builder_configt _content_templatet Nonet
epub_covert rfindt _cover_templateRE t _coverpage_namet projectR R> t
epub_guidet splitR= t _guide_templatet
_guide_titlesR R R R R ( R R R t olent projectfilest roott dirsR Rq R R R RC R t content_tmplt html_tmplR t mpost cpost ctxR t auto_add_covert auto_add_tocR Rh R RJ R ( ( s> /usr/local/lib/python2.7/site-packages/sphinx/builders/epub.pyR s
& - ( ( # #! c C sd | r | j d 7_ n | j d 7_ t | | d <| j t | j | d <| j | d /usr/local/lib/python2.7/site-packages/sphinx/builders/epub.pyt new_navpoint s
c C s/ | j d d } | j d | d j | S( sk Insert nested navpoints for given node.
The node and subnav are already rendered to text.
s
i i( t rsplitRE R ( R RY t subnavt nlist( ( s> /usr/local/lib/python2.7/site-packages/sphinx/builders/epub.pyt
insert_subnav s c C s g } g } d } d } x| D]}} | d s5 q n | d j d d } | | j k ra q n | d | j j k r} q n | d | k r | j | j | | n | d | d k r'| j | g } | d 7} | r | j j r | j | j | | t n | j | j | | no xS | d | k r|d j | } | j
} | j | d | | d <| d 8} q*W| j | j | | | } q WxO | d k rd j | } | j
} | j | d | | d <| d 8} qWd j | S(
s Create the toc navigation structure.
Subelements of a node are nested inside the navpoint. For nested nodes
the parent node is reinserted in the subnav.
i R' R$ R i R& s
iN( R R R R t
epub_tocdepthR0 R t epub_tocdupR= R t popR ( R R t navstackt navlistR& t lastnodeRY RJ R ( ( s> /usr/local/lib/python2.7/site-packages/sphinx/builders/epub.pyt build_navpoints sD
c C s> i } | j j | d <| j j | d <| | d <| | d <| S( s] Create a dictionary with all metadata for the toc.ncx file
properly escaped.
R R R& t navpoints( R R R ( R R& R R ( ( s> /usr/local/lib/python2.7/site-packages/sphinx/builders/epub.pyt toc_metadata s
c C s | j d | | j j d k rl | j j | j j | d t d t } | j | g } | j | n | j } | j
| } t d | j D } t | | j j
} t j t j | | d d } z! | j t | j | | Wd | j Xd S( s Write the metainfo file toc.ncx.s writing %s file...t defaultR8 R9 c s s | ] } | d Vq d S( R& N( ( t .0RC ( ( s> /usr/local/lib/python2.7/site-packages/sphinx/builders/epub.pys s R s utf-8N( R R t
epub_tocscopeR R; R< R= R4 RA R? R t maxt minR R R R R R t
_toc_templateR R ( R R R R5 R? R R& R ( ( s> /usr/local/lib/python2.7/site-packages/sphinx/builders/epub.pyR s !!c C s | j d | d d d g | j } t j t j | | d t j } | j t j | d d t j xi | D]a } t j | | } t j
d k r t | t r | j
d } q n | j | | t j qt W| j d
S( s~ Write the epub file.
It is a zip file with the mimetype file stored uncompressed as the first
entry.
s writing %s file...s META-INF/container.xmls content.opfs toc.ncxR R i i s utf-8N( i i ( R R t zipfilet ZipFileR R t ZIP_DEFLATEDR t
ZIP_STOREDt syst version_infoR( t unicodet encodeR ( R R R R R
RJ t fp( ( s> /usr/local/lib/python2.7/site-packages/sphinx/builders/epub.pyR s
N(& t __name__t
__module__t __doc__R R= t
copysourcet supported_image_typest add_permalinksR> t embeddedR R R R# R4 RD RA RO R\ R R R R R R R R R R R R R R R R R R R ( ( ( s> /usr/local/lib/python2.7/site-packages/sphinx/builders/epub.pyR sF
E
&
z + ( s .svg(2 R0 R t reR) R R R% R t PILR t ImportErrorR t docutilsR t sphinxR t sphinx.builders.htmlR t sphinx.util.osutilR R R t sphinx.util.smartypantsR R1 t sphinx.util.consoleR R R R$ R R
R R R R R R R R/ Ru Rw Rn Rv R R R t compileRT R ( ( ( s> /usr/local/lib/python2.7/site-packages/sphinx/builders/epub.pyt sj