Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Add autodoxy, a sphinx extension heavily inspired from autodoc_doxygen
[simgrid.git] / docs / source / _ext / autodoxy / README
1 This is autodoxy, a sphinx extension providing autodoc-like directives
2 that are feed with Doxygen files.
3
4 It is highly inspired from the autodoc_doxygen sphinx extension, but
5 adapted to my own needs in SimGrid.
6 https://github.com/rmcgibbo/sphinxcontrib-autodoc_doxygen
7
8 The MIT License (MIT)
9
10 Copyright (c) 2015 Robert T. McGibbon
11 Copytight (c) 2019 Martin Quinson
12
13 Permission is hereby granted, free of charge, to any person obtaining
14 a copy of this software and associated documentation files (the
15 "Software"), to deal in the Software without restriction, including
16 without limitation the rights to use, copy, modify, merge, publish,
17 distribute, sublicense, and/or sell copies of the Software, and to
18 permit persons to whom the Software is furnished to do so, subject to
19 the following conditions:
20
21 The above copyright notice and this permission notice shall be
22 included in all
23 copies or substantial portions of the Software.
24
25 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
26 EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
27 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
28 IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
29 CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
30 TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
31 SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.