Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commitdd026f3

Browse files
committed
Bundling and adding Breathe
Breathe is the documentation bridge between Sphinx and Doxygen.
1 parent862f614 commitdd026f3

File tree

130 files changed

+18330
-2
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

130 files changed

+18330
-2
lines changed

‎libs/network/doc/Doxyfile

Lines changed: 1551 additions & 0 deletions
Large diffs are not rendered by default.

‎libs/network/doc/conf.py

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@
1818
# documentation root, use os.path.abspath to make it absolute, like shown here.
1919
#sys.path.append(os.path.abspath('.'))
2020

21+
sys.path.append(os.path.abspath('ext/breathe'))
22+
2123
# -- General configuration -----------------------------------------------------
2224

2325
# Add any Sphinx extension module names here, as strings. They can be extensions
@@ -26,7 +28,9 @@
2628
extensions= ['sphinx.ext.todo',
2729
'sphinx.ext.autodoc',
2830
'sphinx.ext.doctest',
29-
'sphinx.ext.coverage',]
31+
'sphinx.ext.coverage',
32+
'breathe',
33+
]
3034

3135
# Uncomment this to generate output for Github.
3236
# extensions += ['sphinxtogithub']
@@ -73,7 +77,7 @@
7377

7478
# List of directories, relative to source directory, that shouldn't be searched
7579
# for source files.
76-
exclude_trees= ['build']
80+
exclude_trees= ['build','doxyxml','ext']
7781

7882
# The reST default role (used for this markup: `text`) to use for all documents.
7983
#default_role = None
@@ -203,3 +207,9 @@
203207

204208
# If false, no module index is generated.
205209
#latex_use_modindex = True
210+
211+
breathe_projects= {'cpp-netlib':'doxyxml/'}
212+
213+
breathe_default_project='cpp-netlib'
214+
215+
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
*.pyc

‎libs/network/doc/ext/breathe/LICENCE

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
// BSD licence, modified to remove the organisation as there isn't one.
2+
3+
Copyright (c) 2009, Michael Jones
4+
All rights reserved.
5+
6+
Redistribution and use in source and binary forms, with or without modification,
7+
are permitted provided that the following conditions are met:
8+
9+
* Redistributions of source code must retain the above copyright notice,
10+
this list of conditions and the following disclaimer.
11+
* Redistributions in binary form must reproduce the above copyright notice,
12+
this list of conditions and the following disclaimer in the documentation
13+
and/or other materials provided with the distribution.
14+
* The names of its contributors may not be used to endorse or promote
15+
products derived from this software without specific prior written
16+
permission.
17+
18+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
19+
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
20+
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
21+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
22+
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
23+
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
24+
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
25+
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26+
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
27+
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28+
Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
Breathe
2+
=======
3+
4+
This is an extension to restructured text and Sphinx to be able to read and
5+
render the Doxygen xml output.
6+
7+
Documentation
8+
-------------
9+
10+
Documentation is available in the ``testsuite`` folder and up in full `here
11+
<http://michaeljones.github.com/breathe>`_.
12+
13+
Running Testsuite
14+
-----------------
15+
16+
This process assumes the ``sphinx-build`` script is on your path. If it is not,
17+
then either edit ``testsuite/Makefile`` to point at it or create a link to it in
18+
the ``testsuite`` directory.
19+
20+
First run ``make`` for each folder in the examples directory, then::
21+
22+
cd testsuite
23+
make html
24+
25+
Then view the resulting html with your browser of choice.
26+
27+
28+
Requirements
29+
------------
30+
31+
Development is currently done with:
32+
33+
- Python 2.5
34+
- Docutils 0.7
35+
- Sphinx 1.0.4
36+
- Doxygen 1.7.2
37+
38+
Doxygen 1.5.1 seems to produce xml with repeated sections which causes Breathe
39+
some confusion. Not sure when this was resolved but it might be best to go for
40+
the latest possible.
41+
42+
Credits
43+
-------
44+
45+
Thank you to:
46+
47+
- `nijel<http://github.com/nijel>`_
48+
- `sebastianschaetz<http://github.com/sebastianschaetz>`_
49+
- `mbolivar<http://github.com/mbolivar>`_
50+
51+
For their contributions; improving the code and the documentation. And thanks to:
52+
53+
- Dimitri van Heesch for `Doxygen<http://www.stack.nl/~dimitri/doxygen/>`_.
54+
- Georg Brandl for `Sphinx<http://sphinx.pocoo.org>`_.
55+
- David Goodger for `Docutils<http://docutils.sourceforge.net/>`_ and Restructured Text.
56+

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp