X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/d12402e6d9999ad72d856bcaabedd6f9c03c34d6..b1245e5ecc0f1eb4e2b76edac0004005e8c9a514:/docs/source/conf.py diff --git a/docs/source/conf.py b/docs/source/conf.py index 89b8cb2016..96b64bf36f 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -26,17 +26,15 @@ read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True' if read_the_docs_build: subprocess.call('pwd', shell=True) # should be in docs/source subprocess.call('doxygen', shell=True) - subprocess.call('javasphinx-apidoc --force -o java/ ../../src/bindings/java/org/simgrid/msg', shell=True) - subprocess.call('rm java/packages.rst', shell=True) # -- Project information ----------------------------------------------------- project = u'SimGrid' -copyright = u'2002-2021, The SimGrid Team' +copyright = u'2002-2023, The SimGrid Team' author = u'The SimGrid Team' # The short X.Y version -version = u'3.27.1' +version = u'3.35.1' # -- General configuration --------------------------------------------------- @@ -51,10 +49,11 @@ extensions = [ 'sphinx.ext.todo', 'breathe', 'sphinx.ext.autodoc', - 'sphinx.ext.intersphinx', 'sphinx.ext.autosummary', + 'sphinx.ext.intersphinx', + 'sphinx.ext.mathjax', 'sphinx_tabs.tabs', - 'javasphinx', + 'sphinx_copybutton', 'showfile', ] @@ -64,6 +63,10 @@ todo_include_todos = True breathe_projects = {'simgrid': '../build/xml'} breathe_default_project = "simgrid" +# 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 = [ @@ -71,8 +74,8 @@ nitpick_ignore = [ ('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'), @@ -80,46 +83,79 @@ nitpick_ignore = [ ('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', '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'), - ('cpp:identifier', 'simgrid::s4u::Activity_T'), - ('cpp:identifier', 'simgrid::s4u::Activity_T'), - ('cpp:identifier', 'simgrid::xbt'), - ('cpp:identifier', 'this_actor'), + ('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_NetZone'), + ('cpp:identifier', 's4u_Link'), ('cpp:identifier', 's4u_Mailbox'), ('cpp:identifier', 's4u_Mutex'), - ('cpp:identifier', 's4u_Link'), + ('cpp:identifier', 's4u_NetZone'), ('cpp:identifier', 's4u_Semaphore'), - ('cpp:identifier', 's4u_VirtualMachine'), ('cpp:identifier', 's4u_VM'), + ('cpp:identifier', 's4u_VirtualMachine'), + ('cpp:identifier', 'simgrid'), + ('cpp:identifier', 'simgrid::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_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'), - ('cpp:identifier', 'xbt::string'), ] # For cross-ref generation @@ -140,7 +176,7 @@ master_doc = 'index' # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +language = "en" # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files.