X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/7e4525e27a4e0301c932382555fa0b2cd563302c..0a6556cf9aa3e733965b6a18574efd63b54caa0d:/docs/source/conf.py diff --git a/docs/source/conf.py b/docs/source/conf.py index d931437de3..b84834c4f1 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-2022, The SimGrid Team' author = u'The SimGrid Team' # The short X.Y version -version = u'3.25.1' +version = u'3.32.1' # -- General configuration --------------------------------------------------- @@ -54,9 +54,9 @@ extensions = [ 'sphinx.ext.intersphinx', 'sphinx.ext.autosummary', 'sphinx_tabs.tabs', + 'sphinx_copybutton', 'javasphinx', 'showfile', - 'autodoxy', ] todo_include_todos = True @@ -65,38 +65,101 @@ 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"), - ] +# Setup the copybutton extension +copybutton_prompt_text = r">>> |\.\.\. |\$ |In \[\d*\]: | {2,5}\.\.\.: | {5,8}: " +copybutton_prompt_is_regexp = True # 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::activity::ActivityImplPtr'), + ('cpp:identifier', 'kernel::activity::CommImpl'), + ('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::profile::Profile'), + ('cpp:identifier', 'kernel::resource'), + ('cpp:identifier', 'kernel::resource::Action'), + ('cpp:identifier', 'kernel::resource::Action::State'), + ('cpp:identifier', 'kernel::resource::LinkImpl'), + ('cpp:identifier', 'kernel::resource::NetworkAction'), + ('cpp:identifier', 'kernel::resource::SplitDuplexLinkImpl'), + ('cpp:identifier', 'kernel::resource::StandardLinkImpl'), + ('cpp:identifier', 'kernel::routing'), + ('cpp:identifier', 'kernel::routing::NetPoint'), + ('cpp:identifier', 'ns3'), + ('cpp:identifier', 'ns3::Ptr'), + ('cpp:identifier', 'ns3::Node'), + ('cpp:identifier', 's4u'), + ('cpp:identifier', 's4u_Actor'), + ('cpp:identifier', 's4u_Barrier'), + ('cpp:identifier', 's4u_Comm'), + ('cpp:identifier', 's4u_ConditionVariable'), + ('cpp:identifier', 's4u_Disk'), + ('cpp:identifier', 's4u_Exec'), + ('cpp:identifier', 's4u_File'), + ('cpp:identifier', 's4u_Host'), + ('cpp:identifier', 's4u_Link'), + ('cpp:identifier', 's4u_Mailbox'), + ('cpp:identifier', 's4u_Mutex'), + ('cpp:identifier', 's4u_NetZone'), + ('cpp:identifier', 's4u_Semaphore'), + ('cpp:identifier', 's4u_VM'), + ('cpp:identifier', 's4u_VirtualMachine'), + ('cpp:identifier', 'sg_msg_Comm'), + ('cpp:identifier', 'sg_msg_Task'), ('cpp:identifier', 'simgrid'), ('cpp:identifier', 'simgrid::s4u'), - ('cpp:identifier', 'this_actor'), - ('cpp:identifier', 's4u'), + ('cpp:identifier', 'simgrid::s4u::Activity_T'), + ('cpp:identifier', 'simgrid::s4u::Activity_T'), + ('cpp:identifier', 'simgrid::s4u::Activity_T'), + ('cpp:identifier', 'simgrid::s4u::this_actor'), + ('cpp:identifier', 'simgrid::xbt'), ('cpp:identifier', 'size_t'), + ('cpp:identifier', 'ssize_t'), + ('cpp:identifier', 'this_actor'), ('cpp:identifier', 'uint64_t'), ('cpp:identifier', 'xbt'), - ('cpp:identifier', 'xbt::string'), + ('cpp:identifier', 'xbt_dynar_s'), + ('cpp:identifier', 'xbt::Extendable'), + ('cpp:identifier', 'xbt::Extendable'), + ('cpp:identifier', 'xbt::Extendable'), + ('cpp:identifier', 'xbt::Extendable'), + ('cpp:identifier', 'xbt::Extendable'), + ('cpp:identifier', 'xbt::Extendable'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), + ('cpp:identifier', 'xbt::signal'), ] # For cross-ref generation @@ -181,4 +244,3 @@ html_css_files = [ ] # -- Other options -