deploy: e32153f

asap_master/html/.buildinfo

@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: d4115478b5efb94b807eabea7f75d31a
+config: 82e3a1a6d262703875fd79f3b8a25bed
 tags: 645f666f9bcd5a90fca523b33c5a78b7

asap_master/html/_sources/index.rst

@@ -22,7 +22,6 @@ Last Updated on |date|
  getting-started/index
  project-development/index
  documentation/index
- library-modules/index
  tools/index
  license
  changelog.md
@@ -41,29 +40,20 @@ Parts of the documentation
 
 :doc:`Getting Started! <getting-started/index>`
 -----------------------------------------------
-
 *start here to understand how to use this project as a starter for your own
 project*
 
 :doc:`Project Development <project-development/index>`
 ------------------------------------------------------
-
 *refer to this part of the documentation to understand the build system
 specifics for this project, the development workflow, coding and unit testing
 guidelines*
 
 :doc:`Documentation <documentation/index>`
 ------------------------------------------
-
 *refer to this part of the documentation to understand how project documentation
 is structured and built from source using `doxygen` and `sphinx`.*
 
-:doc:`Library Modules <library-modules/index>`
-----------------------------------------------
-*check this out to explore the different modules part of this project. From
-there, you can also jump to the detailed API documentation of each of those
-modules.*
-
 :doc:`Project Tools <tools/index>`
 ----------------------------------
 *get an introduction to the programs and scripts under the `tools` folder,
@@ -74,7 +64,7 @@ use the project artifacts.*
 Acknowledgements
 ================
 
-.. figure:: https://executablebooks.org/en/latest/_static/logo-wide.png
+.. figure:: https://executablebooks.org/en/latest/_static/logo-wide.svg
  :figclass: margin
  :alt: Executable Books Project
  :name: executable_book_logo

asap_master/html/_sources/project-development/modules.rst

@@ -206,48 +206,40 @@ Adding documentation to a module
 Documentation comes in two forms: `doxygen` API documentation and `sphinx`
 documentation. The former is embedded in the source code files, while the latter
 is written in its own separate files placed in a ```doc``` subdirectory under
-the module root.
-
-1. The contents of the `doc` directory can be started by copying some of the
- files from another existing module. In particular, the ```conf.py.in``` file,
- can be copied from an existing module and used without modification.
-
- The module's `CMakeLists.txt` should then be modified to add the targets for
- `doxygen` and `sphinx` documentation build as appropriate.
-
- .. code-block:: CMake
-
- # --------------------------------------------
- # API Documentation
- # --------------------------------------------
-
- asap_with_doxygen(
- MODULE_NAME
- ${MODULE_TARGET_NAME}
- VERSION
- ${META_MODULE_VERSION}
- TITLE
- "\"MyApp Module\""
- BRIEF
- "\"Provides some stuff for MyApp.\""
- INPUT_PATH
- "${CMAKE_CURRENT_SOURCE_DIR}/src ${CMAKE_CURRENT_SOURCE_DIR}/include")
-
- asap_with_sphinx(${MODULE_TARGET_NAME})
-
-2. Add target dependencies from the master sphinx documentation target to the
- module's sphinx documentation target. This step is only required if you have
- added a module sphinx documentation target.
-
- .. code-block:: CMake
-
- add_dependencies(master_sphinx
- copy_doc_index
- # Hardcode `asap` in the module name as we do not want this prefix to
- # change with the forked project name.
- asap_common_sphinx
- asap_logging_sphinx
- # Add more submodule documentation targets after this, using variables
- # in the target names consistently with the module's CMakeLists.txt.
- myapp
- )
+the module root or in a sub-directory under the root ```doc``` directory.
+
+The module's `CMakeLists.txt` should be modified to add the targets for
+`doxygen` as appropriate. .. code-block:: CMake
+
+.. code-block:: CMake
+
+ asap_with_doxygen(
+ MODULE_NAME
+ ${MODULE_TARGET_NAME}
+ VERSION
+ ${META_MODULE_VERSION}
+ TITLE
+ "\"MyApp Module\""
+ BRIEF
+ "\"Provides some stuff for MyApp.\""
+ INPUT_PATH
+ "${CMAKE_CURRENT_SOURCE_DIR}/src ${CMAKE_CURRENT_SOURCE_DIR}/include")
+
+For sphinx documentation, the recommended approach is to have all documentation
+reside within the root ```doc``` directory in order to be able to have one
+single configuration file and most importantly in order to make most IDEs happy
+and generate previews.
+
+The contents of the `doc` directory can be started by copying some of the files
+from another existing module. In particular, the ```conf.py.in``` file, can be
+copied from an existing module and used without modification.
+
+If the module documentation is preferred to be inside the module itself, then a
+separate sphinx project is required. The module's `CMakeLists.txt` should then
+be modified to add the targets for `doxygen` and `sphinx` documentation build as
+appropriate. The module's `CMakeLists.txt` should then be modified to add the targets for
+`sphinx` as appropriate.
+
+.. code-block:: CMake
+
+ asap_with_sphinx(${MODULE_TARGET_NAME})

asap_master/html/_static/basic.css

@@ -237,6 +237,10 @@ a.headerlink {
  visibility: hidden;
 }
 
+a:visited {
+ color: #551A8B;
+}
+
 h1:hover > a.headerlink,
 h2:hover > a.headerlink,
 h3:hover > a.headerlink,
@@ -670,6 +674,16 @@ dd {
  margin-left: 30px;
 }
 
+.sig dd {
+ margin-top: 0px;
+ margin-bottom: 0px;
+}
+
+.sig dl {
+ margin-top: 0px;
+ margin-bottom: 0px;
+}
+
 dl > dd:last-child,
 dl > dd:last-child > :last-child {
  margin-bottom: 0;
@@ -738,6 +752,14 @@ abbr, acronym {
  cursor: help;
 }
 
+.translated {
+ background-color: rgba(207, 255, 207, 0.2)
+}
+
+.untranslated {
+ background-color: rgba(255, 207, 207, 0.2)
+}
+
 /* -- code displays --------------------------------------------------------- */
 
 pre {

asap_master/html/_static/copybutton.js

@@ -20,7 +20,7 @@ const messages = {
  },
  'fr' : {
  'copy': 'Copier',
- 'copy_to_clipboard': 'Copié dans le presse-papier',
+ 'copy_to_clipboard': 'Copier dans le presse-papier',
  'copy_success': 'Copié !',
  'copy_failure': 'Échec de la copie',
  },
@@ -224,7 +224,7 @@ var copyTargetText = (trigger) => {
  var target = document.querySelector(trigger.attributes['data-clipboard-target'].value);
 
  // get filtered text
- let exclude = '.linenos, .gp';
+ let exclude = '.linenos';
 
  let text = filterText(target, exclude);
  return formatCopyText(text, '', false, true, true, true, '', '')

asap_master/html/_static/documentation_options.js

@@ -1,14 +1,13 @@
-var DOCUMENTATION_OPTIONS = {
- URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'),
- VERSION: '4.6.3 (42d995a184ac)',
+const DOCUMENTATION_OPTIONS = {
+ VERSION: '4.7.0 (e32153f36015)',
  LANGUAGE: 'en',
  COLLAPSE_INDEX: false,
  BUILDER: 'html',
  FILE_SUFFIX: '.html',
  LINK_SUFFIX: '.html',
  HAS_SOURCE: true,
  SOURCELINK_SUFFIX: '',
- NAVIGATION_WITH_KEYS: true,
+ NAVIGATION_WITH_KEYS: false,
  SHOW_SEARCH_SUMMARY: true,
  ENABLE_SEARCH_SHORTCUTS: true,
 };

asap_master/html/_static/locales/ar/LC_MESSAGES/booktheme.po

@@ -8,68 +8,68 @@ msgstr ""
 "Language: ar\n"
 "Plural-Forms: nplurals=2; plural=(n != 1);\n"
 
-msgid "By"
-msgstr "بواسطة"
-
-msgid "repository"
-msgstr "مخزن"
-
-msgid "Fullscreen mode"
-msgstr "وضع ملء الشاشة"
-
-msgid "Contents"
-msgstr "محتويات"
-
 msgid "Download source file"
 msgstr "تنزيل ملف المصدر"
 
-msgid "Edit this page"
-msgstr "قم بتحرير هذه الصفحة"
-
-msgid "Last updated on"
-msgstr "آخر تحديث في"
-
-msgid "Print to PDF"
-msgstr "طباعة إلى PDF"
-
 msgid "suggest edit"
 msgstr "أقترح تحرير"
 
-msgid "Download this page"
-msgstr "قم بتنزيل هذه الصفحة"
-
 msgid "Toggle navigation"
 msgstr "تبديل التنقل"
 
-msgid "By the"
-msgstr "بواسطة"
-
-msgid "Sphinx Book Theme"
-msgstr "موضوع كتاب أبو الهول"
-
-msgid "previous page"
-msgstr "الصفحة السابقة"
-
-msgid "Source repository"
-msgstr "مستودع المصدر"
-
 msgid "open issue"
 msgstr "قضية مفتوحة"
 
 msgid "Download notebook file"
 msgstr "تنزيل ملف دفتر الملاحظات"
 
-msgid "Copyright"
-msgstr "حقوق النشر"
+msgid "repository"
+msgstr "مخزن"
 
 msgid "Theme by the"
 msgstr "موضوع بواسطة"
 
+msgid "Print to PDF"
+msgstr "طباعة إلى PDF"
+
+msgid "Download this page"
+msgstr "قم بتنزيل هذه الصفحة"
+
+msgid "Copyright"
+msgstr "حقوق النشر"
+
+msgid "Last updated on"
+msgstr "آخر تحديث في"
+
+msgid "Launch"
+msgstr "إطلاق"
+
 msgid "Open an issue"
 msgstr "افتح قضية"
 
+msgid "Fullscreen mode"
+msgstr "وضع ملء الشاشة"
+
+msgid "Sphinx Book Theme"
+msgstr "موضوع كتاب أبو الهول"
+
+msgid "Contents"
+msgstr "محتويات"
+
+msgid "Edit this page"
+msgstr "قم بتحرير هذه الصفحة"
+
 msgid "next page"
 msgstr "الصفحة التالية"
 
-msgid "Launch"
-msgstr "إطلاق"
+msgid "Source repository"
+msgstr "مستودع المصدر"
+
+msgid "By"
+msgstr "بواسطة"
+
+msgid "By the"
+msgstr "بواسطة"
+
+msgid "previous page"
+msgstr "الصفحة السابقة"