Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Start the dev of 3.28.
[simgrid.git] / docs / source / conf.py
index d931437..89b8cb2 100644 (file)
@@ -32,11 +32,11 @@ if read_the_docs_build:
 # -- Project information -----------------------------------------------------
 
 project = u'SimGrid'
-copyright = u'2002-2020, The SimGrid Team'
+copyright = u'2002-2021, The SimGrid Team'
 author = u'The SimGrid Team'
 
 # The short X.Y version
-version = u'3.25.1'
+version = u'3.27.1'
 
 # -- General configuration ---------------------------------------------------
 
@@ -56,7 +56,6 @@ extensions = [
     'sphinx_tabs.tabs',
     'javasphinx',
     'showfile',
-    'autodoxy',
 ]
 
 todo_include_todos = True
@@ -65,37 +64,61 @@ todo_include_todos = True
 breathe_projects = {'simgrid': '../build/xml'}
 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
-    ("ActorPtr", "simgrid::s4u::ActorPtr"),
-    ("Actor", "simgrid::s4u::Actor"),
-    ("CommPtr", "simgrid::s4u::CommPtr"),
-    ("Disk", "simgrid::s4u::Disk"),
-    ("ExecPtr", "simgrid::s4u::ExecPtr"),
-    ("Host", "simgrid::s4u::Host"),
-    ("s4u::Host", "simgrid::s4u::Host"),
-    ("Engine", "simgrid::s4u::Engine"),
-    ("Link", "simgrid::s4u::Link"),
-    ("Mailbox", "simgrid::s4u::Mailbox"),
-    ("Mutex", "simgrid::s4u::Mutex"),
-    ("s4u::Mutex", "simgrid::s4u::Mutex"),
-    ("NetZone", "simgrid::s4u::NetZone"),
-    ("Semaphore", "simgrid::s4u::Semaphore"),
-  ]
-
 # 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<ConditionVariable>'),
+  ('cpp:identifier', 'boost::intrusive_ptr<Comm>'),
+  ('cpp:identifier', 'boost::intrusive_ptr<Exec>'),
+  ('cpp:identifier', 'boost::intrusive_ptr<Io>'),
+  ('cpp:identifier', 'boost::intrusive_ptr<Mutex>'),
+  ('cpp:identifier', 'boost::intrusive_ptr<Semaphore>'),
   ('cpp:identifier', 'kernel'),
+  ('cpp:identifier', 'kernel::activity'),
+  ('cpp:identifier', 'kernel::activity::ActivityImplPtr'),
+  ('cpp:identifier', 'kernel::activity::CommImplPtr'),
+  ('cpp:identifier', 'kernel::actor'),
+  ('cpp:identifier', 'kernel::actor::ActorCodeFactory'),
+  ('cpp:identifier', 'kernel::actor::ActorImpl'),
+  ('cpp:identifier', 'kernel::profile'),
+  ('cpp:identifier', 'kernel::resource'),
+  ('cpp:identifier', 'kernel::resource::Action'),
+  ('cpp:identifier', 'kernel::resource::NetworkAction'),
+  ('cpp:identifier', 'kernel::routing'),
+  ('cpp:identifier', 'kernel::routing::NetPoint'),
+  ('cpp:identifier', 'sg_msg_Comm'),
+  ('cpp:identifier', 'sg_msg_Task'),
   ('cpp:identifier', 'simgrid'),
   ('cpp:identifier', 'simgrid::s4u'),
+  ('cpp:identifier', 'simgrid::s4u::this_actor'),
+  ('cpp:identifier', 'simgrid::s4u::Activity_T<Comm>'),
+  ('cpp:identifier', 'simgrid::s4u::Activity_T<Exec>'),
+  ('cpp:identifier', 'simgrid::s4u::Activity_T<Io>'),
+  ('cpp:identifier', 'simgrid::xbt'),
   ('cpp:identifier', 'this_actor'),
   ('cpp:identifier', 's4u'),
+  ('cpp:identifier', 's4u_Actor'),
+  ('cpp:identifier', 's4u_Barrier'),
+  ('cpp:identifier', 's4u_Comm'),
+  ('cpp:identifier', 's4u_ConditionVariable'),
+  ('cpp:identifier', 's4u_Exec'),
+  ('cpp:identifier', 's4u_Host'),
+  ('cpp:identifier', 's4u_NetZone'),
+  ('cpp:identifier', 's4u_Mailbox'),
+  ('cpp:identifier', 's4u_Mutex'),
+  ('cpp:identifier', 's4u_Link'),
+  ('cpp:identifier', 's4u_Semaphore'),
+  ('cpp:identifier', 's4u_VirtualMachine'),
+  ('cpp:identifier', 's4u_VM'),
   ('cpp:identifier', 'size_t'),
   ('cpp:identifier', 'uint64_t'),
   ('cpp:identifier', 'xbt'),
+  ('cpp:identifier', 'xbt::signal<void()>'),
+  ('cpp:identifier', 'xbt::signal<void(void)>'),
   ('cpp:identifier', 'xbt::string'),
 ]
 
@@ -181,4 +204,3 @@ html_css_files = [
 ]
 
 # -- Other options
-