Fix some warnings in doc generation.

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

diff --git a/docs/source/conf.py b/docs/source/conf.py
index b287522..03d7271 100644 (file)
--- 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.31.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,8 +65,104 @@ 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")
+# 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<Activity>'),
+  ('cpp:identifier', 'boost::intrusive_ptr<Actor>'),
+  ('cpp:identifier', 'boost::intrusive_ptr<Barrier>'),
+  ('cpp:identifier', 'boost::intrusive_ptr<Comm>'),
+  ('cpp:identifier', 'boost::intrusive_ptr<ConditionVariable>'),
+  ('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::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<ns3::Node>'),
+  ('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', 'simgrid::s4u::Activity_T<Comm>'),
+  ('cpp:identifier', 'simgrid::s4u::Activity_T<Exec>'),
+  ('cpp:identifier', 'simgrid::s4u::Activity_T<Io>'),
+  ('cpp:identifier', 'simgrid::s4u::this_actor'),
+  ('cpp:identifier', 'simgrid::xbt'),
+  ('cpp:identifier', 'simgrid::xbt::string'),
+  ('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<Activity>'),
+  ('cpp:identifier', 'xbt::Extendable<Actor>'),
+  ('cpp:identifier', 'xbt::Extendable<Disk>'),
+  ('cpp:identifier', 'xbt::Extendable<File>'),
+  ('cpp:identifier', 'xbt::Extendable<Host>'),
+  ('cpp:identifier', 'xbt::Extendable<Link>'),
+  ('cpp:identifier', 'xbt::signal<void()>'),
+  ('cpp:identifier', 'xbt::signal<void(Actor const&)>'),
+  ('cpp:identifier', 'xbt::signal<void(Actor&)>'),
+  ('cpp:identifier', 'xbt::signal<void(Comm const&)>'),
+  ('cpp:identifier', 'xbt::signal<void(Comm const&, bool is_sender)>'),
+  ('cpp:identifier', 'xbt::signal<void(Disk const&)>'),
+  ('cpp:identifier', 'xbt::signal<void(Disk&)>'),
+  ('cpp:identifier', 'xbt::signal<void(Exec const&)>'),
+  ('cpp:identifier', 'xbt::signal<void(Host const&)>'),
+  ('cpp:identifier', 'xbt::signal<void(Host&)>'),
+  ('cpp:identifier', 'xbt::signal<void(Link const&)>'),
+  ('cpp:identifier', 'xbt::signal<void(Link&)>'),
+  ('cpp:identifier', 'xbt::signal<void(NetZone const&)>'),
+  ('cpp:identifier', 'xbt::signal<void(VirtualMachine const&)>'),
+  ('cpp:identifier', 'xbt::signal<void(const Actor&, const Host &previous_location)>'),
+  ('cpp:identifier', 'xbt::signal<void(double)>'),
+  ('cpp:identifier', 'xbt::signal<void(kernel::resource::NetworkAction&)>'),
+  ('cpp:identifier', 'xbt::signal<void(kernel::resource::NetworkAction&, kernel::resource::Action::State)>'),
+  ('cpp:identifier', 'xbt::signal<void(void)>'),
+  ('cpp:identifier', 'xbt::string'),
+]
 
 # For cross-ref generation
 primary_domain = 'cpp'
@@ -117,7 +213,7 @@ html_theme_options = {
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-# html_static_path = ['_static']
+html_static_path = ['_static']
 
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.
@@ -132,7 +228,7 @@ html_theme_options = {
 # -- Options for HTMLHelp output ---------------------------------------------
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'SimGrid-doc'
+htmlhelp_basename = 'simgrid-doc'
 
 # -- Options for GitLab integration ------------------------------------------
 
@@ -145,6 +241,8 @@ html_context = {
     "conf_py_path": "/docs/source/",  # Path in the checkout to the docs root
 }
 
-# -- Other options
+html_css_files = [
+    'css/custom.css',
+]
 
-nitpicky = True # Generate a warning for all a cross-reference (such as :func:`myfunc`) that cannot be found
+# -- Other options