import os
import subprocess
-# Search for our extensions too
+# Search for our extensions too
import sys
sys.path.append(os.path.abspath('_ext'))
read_the_docs_build = os.environ.get('READTHEDOCS', None) == 'True'
if read_the_docs_build:
- subprocess.call('cd source; doxygen', shell=True)
- subprocess.call('source/_ext/javasphinx-apidoc --force -o source/java/ ../src/bindings/java/org/simgrid/msg', shell=True)
- subprocess.call('rm source/java/packages.rst', shell=True)
+ 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-2019, The SimGrid Team'
+copyright = u'2002-2022, The SimGrid Team'
author = u'The SimGrid Team'
# The short X.Y version
-version = u'3.23.1'
-# The full version, including alpha/beta/rc tags
-#release = u'3.23 alpha'
+version = u'3.31.1'
# -- General configuration ---------------------------------------------------
extensions = [
'sphinx.ext.todo',
'breathe',
- # 'exhale',
'sphinx.ext.autodoc',
'sphinx.ext.intersphinx',
- # 'sphinx.ext.napoleon',
'sphinx.ext.autosummary',
- 'hidden_code_block',
+ 'sphinx_tabs.tabs',
+ 'sphinx_copybutton',
'javasphinx',
+ 'showfile',
]
todo_include_todos = True
+# Setup the breath extension
breathe_projects = {'simgrid': '../build/xml'}
breathe_default_project = "simgrid"
-# Setup the exhale extension
-
-exhale_args = {
- # These arguments are required
- "containmentFolder": "./api",
- "rootFileName": "library_root.rst",
- "rootFileTitle": "SimGrid Full API",
- "doxygenStripFromPath": "..",
- # Suggested optional arguments
- "createTreeView": True,
- "exhaleExecutesDoxygen": False,
- # "exhaleUseDoxyfile": True,
-}
-
+# 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'
-
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# 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.
# -- Options for HTMLHelp output ---------------------------------------------
# Output file base name for HTML help builder.
-htmlhelp_basename = 'SimGrid-doc'
+htmlhelp_basename = 'simgrid-doc'
# -- Options for GitLab integration ------------------------------------------
"gitlab_version": "master", # Version
"conf_py_path": "/docs/source/", # Path in the checkout to the docs root
}
+
+html_css_files = [
+ 'css/custom.css',
+]
+
+# -- Other options
