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

Timestamp:

Feb 26, 2014 11:46:32 PM (10 years ago)

Author:

bennylp

Comment:

--

pjsip-doc/breathe

@@ -7 +7 @@
 ------------
 
-1. Sphinx: http://sphinx-doc.org. I installed with PyPI::
-   
-   $ sudo pip install sphinx
-2. Breathe: http://michaeljones.github.io/breathe/index.html. I installed with PyPI::
-   
+This documentation is created with `Sphinx <http://sphinx-doc.org>`_ and `Breathe <http://michaeljones.github.io/breathe/index.html>`_. Here are the required tools:
+
+1. Doxygen is required. `Install <http://www.stack.nl/~dimitri/doxygen/download.html#srcbin>`_ it for your platform.
+
+2. 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::
+
    $ sudo pip install breathe
-   
-3. Doxygen. I installed from Ubuntu package.
-4. Some say Pygments are needed for syntax coloring. I didn't remember installing it, maybe it was preinstalled, and I have no problem 
-   with syntax coloring (see demo below).
+
+3. Otherwise consult Sphinx and Breathe sites for installation instructions and you may need to install these manually:
+
+  - docutils
+  - Pygments
+  - `Sphinx <http://sphinx-doc.org>`_
+  - `Breathe <http://michaeljones.github.io/breathe/index.html>`_