Merge branch 'master' into 'master'

[simgrid.git] / docs / source / conf.py

diff --git a/docs/source/conf.py b/docs/source/conf.py
index e8de0fb..f3907e4 100644 (file)
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -67,6 +67,57 @@ breathe_default_project = "simgrid"
 
 # 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'),
+]
 
 # For cross-ref generation
 primary_domain = 'cpp'
@@ -132,7 +183,7 @@ html_static_path = ['_static']
 # -- Options for HTMLHelp output ---------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'SimGrid-doc'
+htmlhelp_basename = 'simgrid-doc'
 
 # -- Options for GitLab integration ------------------------------------------
 
@@ -150,5 +201,3 @@ html_css_files = [
 ]
 
 # -- Other options
-
-nitpicky = True # Generate a warning for all a cross-reference (such as :func:`myfunc`) that cannot be found