X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/d9dde0b9bb9032fdea9a8caa97b5fec79f9ca280..d1db98662081c1ad310c5282842f49c447b5c9b3:/docs/source/conf.py diff --git a/docs/source/conf.py b/docs/source/conf.py index 0ca9461b26..432ece9689 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -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.26.1' # -- General configuration --------------------------------------------------- @@ -67,6 +67,71 @@ 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'), + ('cpp:identifier', 'boost::intrusive_ptr'), + ('cpp:identifier', 'boost::intrusive_ptr'), + ('cpp:identifier', 'boost::intrusive_ptr'), + ('cpp:identifier', 'boost::intrusive_ptr'), + ('cpp:identifier', 'boost::intrusive_ptr'), + ('cpp:identifier', 'boost::intrusive_ptr'), + ('cpp:identifier', 'boost::intrusive_ptr'), + ('cpp:identifier', 'boost::intrusive_ptr'), + ('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', 'simgrid::xbt'), + ('cpp:identifier', 'this_actor'), + ('cpp:identifier', 's4u'), + ('cpp:identifier', 's4u_Actor'), + ('cpp:identifier', 's4u_Barrier'), + ('cpp:identifier', 's4u_ConditionVariable'), + ('cpp:identifier', 's4u_Host'), + ('cpp:identifier', 's4u_NetZone'), + ('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::string'), +] # For cross-ref generation primary_domain = 'cpp' @@ -150,5 +215,3 @@ html_css_files = [ ] # -- Other options - -nitpicky = True # Generate a warning for all a cross-reference (such as :func:`myfunc`) that cannot be found