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


Ignore:
Timestamp:
Feb 26, 2014 11:46:32 PM (8 years ago)
Author:
bennylp
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • pjsip-doc/breathe

    v3 v4  
    77------------ 
    88 
    9 1. Sphinx: http://sphinx-doc.org. I installed with PyPI:: 
    10     
    11    $ sudo pip install sphinx 
    12 2. Breathe: http://michaeljones.github.io/breathe/index.html. I installed with PyPI:: 
    13     
     9This documentation is created with `Sphinx <http://sphinx-doc.org>`_ and `Breathe <http://michaeljones.github.io/breathe/index.html>`_. Here are the required tools: 
     10 
     111. Doxygen is required. `Install <http://www.stack.nl/~dimitri/doxygen/download.html#srcbin>`_ it for your platform. 
     12 
     132. On Ubuntu, the easiest way to install all the tools is with `Python Package Index (PyPI) <http://pypi.python.org>`_. Just run this and it will install Sphinx, Breathe, and all the required tools if they are not installed:: 
     14 
    1415   $ sudo pip install breathe 
    15     
    16 3. Doxygen. I installed from Ubuntu package. 
    17 4. Some say Pygments are needed for syntax coloring. I didn't remember installing it, maybe it was preinstalled, and I have no problem  
    18    with syntax coloring (see demo below). 
     16 
     173. Otherwise consult Sphinx and Breathe sites for installation instructions and you may need to install these manually: 
     18 
     19  - docutils 
     20  - Pygments 
     21  - `Sphinx <http://sphinx-doc.org>`_ 
     22  - `Breathe <http://michaeljones.github.io/breathe/index.html>`_ 
    1923 
    2024