Changes between Version 2 and Version 3 of pjsip-doc/breathe
- Timestamp:
- Feb 26, 2014 7:00:49 AM (11 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
pjsip-doc/breathe
v2 v3 1 1 {{{ 2 Doxygen Integration with Breathe 2 #!rst 3 Generating This Documentation 3 4 ================================ 4 People say that the best way to use C++ with Sphinx is with Breathe. It seems to work, with some limitations though.5 5 6 6 Requirements … … 19 19 20 20 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:: 21 Rendering The Documentation 22 ------------------------------ 23 The 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. 25 24 25 To render the documentation as HTML in `_build/html` directory:: 26 27 $ cd $PJDIR/doc/pjsip-book 28 $ python fetch_trac.py 26 29 $ make 27 30 28 T his will build HTML documentation in `_build/html` directory. Tbuild PDF, run::31 To build PDF, run:: 29 32 30 33 $ make latexpdf 31 34 32 33 .. default-domain:: cpp34 35 35 36 How to Use Integrate Book with Doxygen … … 72 73 73 74 75 .. default-domain:: cpp 74 76 75 77 will be rendered like this: