Changes between Version 2 and Version 3 of pjsip-doc/breathe


Ignore:
Timestamp:
Feb 26, 2014 7:00:49 AM (8 years ago)
Author:
bennylp
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • pjsip-doc/breathe

    v2 v3  
    11{{{ 
    2 Doxygen Integration with Breathe 
     2#!rst 
     3Generating This Documentation 
    34================================ 
    4 People say that the best way to use C++ with Sphinx is with Breathe. It seems to work, with some limitations though. 
    55 
    66Requirements 
     
    1919 
    2020 
    21 Setup 
    22 ----- 
    23 The emailed a tarball containing the pjsip-book source files with Doxygen integration. HTML output has already been generated for sample.  
    24 Put this in `$PJ_DIR/doc` so that it becomes `$PJDIR/doc/pjsip-book`. Then just run make:: 
     21Rendering The Documentation 
     22------------------------------ 
     23The main source of the documentation is currently the '''Trac''' pages at https://trac.pjsip.org/repos/wiki/pjsip-doc/index. The copies in SVN are just copies for backup. 
    2524 
     25To render the documentation as HTML in `_build/html` directory:: 
     26 
     27  $ cd $PJDIR/doc/pjsip-book 
     28  $ python fetch_trac.py 
    2629  $ make 
    2730   
    28 This will build HTML documentation in `_build/html` directory. T build PDF, run:: 
     31To build PDF, run:: 
    2932 
    3033  $ make latexpdf 
    3134 
    32  
    33 .. default-domain:: cpp 
    3435 
    3536How to Use Integrate Book with Doxygen 
     
    7273 
    7374      
     75.. default-domain:: cpp 
    7476 
    7577will be rendered like this: