annotate doc/conf.py @ 237:1bf5bd306bb0

core: add alloc_pool_get function
author David Demelier <markand@malikania.fr>
date Fri, 27 Nov 2020 13:31:27 +0100
parents 6f6c49b95f77
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
191
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 #
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 # conf.py -- sphinx documentation configuration
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 #
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
4 # Copyright (c) 2020 David Demelier <markand@malikania.fr>
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 #
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 # Permission to use, copy, modify, and/or distribute this software for any
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 # purpose with or without fee is hereby granted, provided that the above
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 # copyright notice and this permission notice appear in all copies.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 #
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 #
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 # Project information.
220
617fda414bbb js: remove Javascript API for now
David Demelier <markand@malikania.fr>
parents: 191
diff changeset
20 project = "Molko's Adventure"
191
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
21 copyright = "2020, David Demelier"
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 author = "David Demelier"
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 release = '0.1.0'
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
24
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 # General settings.
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 templates_path = ["_templates"]
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
28
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 # HTML output.
224
6f6c49b95f77 doc: add libcore API
David Demelier <markand@malikania.fr>
parents: 220
diff changeset
30 html_theme = "haiku"
191
633a25df450e molko-js: miscellaneous fixes
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 html_static_path = ["_static"]
224
6f6c49b95f77 doc: add libcore API
David Demelier <markand@malikania.fr>
parents: 220
diff changeset
32
6f6c49b95f77 doc: add libcore API
David Demelier <markand@malikania.fr>
parents: 220
diff changeset
33 # Doxygen bridge through breathe.
6f6c49b95f77 doc: add libcore API
David Demelier <markand@malikania.fr>
parents: 220
diff changeset
34 extensions = [ "breathe" ]
6f6c49b95f77 doc: add libcore API
David Demelier <markand@malikania.fr>
parents: 220
diff changeset
35 breathe_projects = {
6f6c49b95f77 doc: add libcore API
David Demelier <markand@malikania.fr>
parents: 220
diff changeset
36 "molko": "@doxygen_BINARY_DIR@/doxygen/xml"
6f6c49b95f77 doc: add libcore API
David Demelier <markand@malikania.fr>
parents: 220
diff changeset
37 }
6f6c49b95f77 doc: add libcore API
David Demelier <markand@malikania.fr>
parents: 220
diff changeset
38 breathe_default_project = "molko"