-# Setup the exhale extension
-exhale_args = {
- # These arguments are required
- "containmentFolder": "./api",
- "rootFileName": "library_root.rst",
- "rootFileTitle": "SimGrid Full API",
- "doxygenStripFromPath": "..",
- # Suggested optional arguments
- "createTreeView": True,
- # TIP: if using the sphinx-bootstrap-theme, you need
- # "treeViewIsBootstrap": True,
- "exhaleExecutesDoxygen": True,
- "exhaleDoxygenStdin": """
- INPUT = ../../include/simgrid/s4u
- GENERATE_XML = YES
- PREDEFINED += \
- __cplusplus \
- DOXYGEN \
- XBT_PUBLIC= \
- XBT_EXPORT_NO_IMPORT= \
- XBT_IMPORT_NO_EXPORT= \
- XBT_PUBLIC_DATA=extern \
- XBT_PUBLIC= \
- XBT_INLINE= \
- XBT_ALWAYS_INLINE= \
- XBT_PRIVATE= \
- XBT_ATTRIB_NORETURN= \
- XBT_ATTRIB_UNUSED= \
- XBT_ATTRIB_DEPRECATED_v322(m)= \
- XBT_ATTRIB_DEPRECATED_v323(m)= \
- XBT_ATTRIB_DEPRECATED_v324(m)=
- """
-}
+# Setup the autodoxy extension
+doxygen_xml = os.path.join(os.path.dirname(__file__), "..", "build", "xml")
+autodoxy_requalified_identifiers = [ # The first element will be substituted into the second one if it's starting an element or preceded by a space
+ ("Activity", "simgrid::s4u::Activity"),
+ ("Actor", "simgrid::s4u::Actor"),
+ ("ActorPtr", "simgrid::s4u::ActorPtr"),
+ ("Barrier", "simgrid::s4u::Barrier"),
+ ("BarrierPtr", "simgrid::s4u::BarrierPtr"),
+ ("Comm", "simgrid::s4u::Comm"),
+ ("CommPtr", "simgrid::s4u::CommPtr"),
+ ("ConditionVariable", "simgrid::s4u::ConditionVariable"),
+ ("ConditionVariablePtr", "simgrid::s4u::ConditionVariablePtr"),
+ ("Disk", "simgrid::s4u::Disk"),
+ ("Exec", "simgrid::s4u::Exec"),
+ ("ExecPtr", "simgrid::s4u::ExecPtr"),
+ ("Host", "simgrid::s4u::Host"),
+ ("s4u::Host", "simgrid::s4u::Host"),
+ ("Engine", "simgrid::s4u::Engine"),
+ ("Io", "simgrid::s4u::Io"),
+ ("Link", "simgrid::s4u::Link"),
+ ("Mailbox", "simgrid::s4u::Mailbox"),
+ ("Mutex", "simgrid::s4u::Mutex"),
+ ("s4u::Mutex", "simgrid::s4u::Mutex"),
+ ("s4u::MutexPtr", "simgrid::s4u::MutexPtr"),
+ ("NetZone", "simgrid::s4u::NetZone"),
+ ("Semaphore", "simgrid::s4u::Semaphore"),
+ ("VirtualMachine", "simgrid::s4u::VirtualMachine"),
+ ]
+
+# Generate a warning for all a cross-reference (such as :func:`myfunc`) that cannot be found
+nitpicky = True
+nitpick_ignore = [
+ ('cpp:identifier', 'boost'),
+ ('cpp:identifier', 'boost::intrusive_ptr<Activity>'),
+ ('cpp:identifier', 'boost::intrusive_ptr<Actor>'),
+ ('cpp:identifier', 'boost::intrusive_ptr<Barrier>'),
+ ('cpp:identifier', 'boost::intrusive_ptr<Comm>'),
+ ('cpp:identifier', 'boost::intrusive_ptr<Io>'),
+ ('cpp:identifier', 'boost::intrusive_ptr<Mutex>'),
+ ('cpp:identifier', 'kernel'),
+ ('cpp:identifier', 'kernel::activity'),
+ ('cpp:identifier', 'kernel::profile'),
+ ('cpp:identifier', 'kernel::resource'),
+ ('cpp:identifier', 'kernel::routing'),
+ ('cpp:identifier', 'simgrid'),
+ ('cpp:identifier', 'simgrid::s4u'),
+ ('cpp:identifier', 'this_actor'),
+ ('cpp:identifier', 's4u'),
+ ('cpp:identifier', 'size_t'),
+ ('cpp:identifier', 'uint64_t'),
+ ('cpp:identifier', 'xbt'),
+ ('cpp:identifier', 'xbt::string'),
+]