fix documentation generation

README.rst

-Board alerts
+Board Alerts
 ============
 
 Send emails at regular intervals to summarize the contents of a dashboard.

doc/HISTORY.rst

-../NEWS
\ No newline at end of file

doc/Makefile

@@ -13,7 +13,7 @@
 endif
 
 project:=$(shell basename $(shell readlink -f ..))
-branch:=$(shell hg branch)
+branch:=$(shell hg identify --branch)
 
 # Internal variables.
 PAPEROPT_a4     = -D latex_paper_size=a4

doc/NEWS.rst

+../NEWS.rst
\ No newline at end of file

doc/conf.py

-# -*- coding: utf-8 -*-
-# flake8: noqa
-#
-# Documentation build configuration file
-#
 # This file is execfile()d with the current directory set to its
 # containing dir.
 #
@@ -26,9 +21,6 @@
 
 # -- General configuration ------------------------------------------------
 
-# If your documentation needs a minimal Sphinx version, state it here.
-# needs_sphinx = '1.0'
-
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
@@ -46,6 +38,5 @@
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
-# source_suffix = ['.rst', '.md']
 source_suffix = ".rst"
 
@@ -50,8 +41,5 @@
 source_suffix = ".rst"
 
-# The encoding of source files.
-# source_encoding = 'utf-8-sig'
-
 # The master toctree document.
 master_doc = "index"
 
@@ -82,13 +70,7 @@
 # Usually you set "language" from the command line for these cases.
 language = None
 
-# There are two options for replacing |today|: either, you set today to some
-# non-false value, then it is used:
-# today = ''
-# Else, today_fmt is used as the format for a strftime call.
-# today_fmt = '%B %d, %Y'
-
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 exclude_patterns = ["_build"]
 
@@ -91,22 +73,7 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 exclude_patterns = ["_build"]
 
-# The reST default role (used for this markup: `text`) to use for all
-# documents.
-# default_role = None
-
-# If true, '()' will be appended to :func: etc. cross-reference text.
-# add_function_parentheses = True
-
-# If true, the current module name will be prepended to all description
-# unit titles (such as .. function::).
-# add_module_names = True
-
-# If true, sectionauthor and moduleauthor directives will be shown in the
-# output. They are ignored by default.
-# show_authors = False
-
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = "sphinx"
 
@@ -110,12 +77,6 @@
 # The name of the Pygments (syntax highlighting) style to use.
 pygments_style = "sphinx"
 
-# A list of ignored prefixes for module index sorting.
-# modindex_common_prefix = []
-
-# If true, keep warnings as "system message" paragraphs in the built documents.
-# keep_warnings = False
-
 # If true, `todo` and `todoList` produce output, else they produce nothing.
 todo_include_todos = True
 
@@ -126,32 +87,8 @@
 # a list of builtin themes.
 html_theme = "default"
 
-# Theme options are theme-specific and customize the look and feel of a theme
-# further.  For a list of options available for each theme, see the
-# documentation.
-# html_theme_options = {}
-
-# Add any paths that contain custom themes here, relative to this directory.
-# html_theme_path = []
-
-# The name for this set of Sphinx documents.  If None, it defaults to
-# "<project> v<release> documentation".
-# html_title = None
-
-# A shorter title for the navigation bar.  Default is the same as html_title.
-# html_short_title = None
-
-# The name of an image file (relative to this directory) to place at the top
-# of the sidebar.
-# html_logo = None
-
-# The name of an image file (relative to this directory) to use as a favicon of
-# the docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
-# pixels large.
-# html_favicon = None
-
 # 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 = ["doc_images"]
 
@@ -153,70 +90,10 @@
 # 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 = ["doc_images"]
 
-# Add any extra paths that contain custom files (such as robots.txt or
-# .htaccess) here, relative to this directory. These files are copied
-# directly to the root of the documentation.
-# html_extra_path = []
-
-# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
-# using the given strftime format.
-# html_last_updated_fmt = '%b %d, %Y'
-
-# If true, SmartyPants will be used to convert quotes and dashes to
-# typographically correct entities.
-# html_use_smartypants = True
-
-# Custom sidebar templates, maps document names to template names.
-# html_sidebars = {}
-
-# Additional templates that should be rendered to pages, maps page names to
-# template names.
-# html_additional_pages = {}
-
-# If false, no module index is generated.
-# html_domain_indices = True
-
-# If false, no index is generated.
-# html_use_index = True
-
-# If true, the index is split into individual pages for each letter.
-# html_split_index = False
-
-# If true, links to the reST sources are added to the pages.
-# html_show_sourcelink = True
-
-# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-# html_show_sphinx = True
-
-# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-# html_show_copyright = True
-
-# If true, an OpenSearch description file will be output, and all pages will
-# contain a <link> tag referring to it.  The value of this option must be the
-# base URL from which the finished HTML is served.
-# html_use_opensearch = ''
-
-# This is the file name suffix for HTML files (e.g. ".xhtml").
-# html_file_suffix = None
-
-# Language to be used for generating the HTML full-text search index.
-# Sphinx supports the following languages:
-#   'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
-#   'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
-# html_search_language = 'en'
-
-# A dictionary with options for the search language support, empty by default.
-# Now only 'ja' uses this config value
-# html_search_options = {'type': 'default'}
-
-# The name of a javascript file (relative to the configuration directory) that
-# implements a search results scorer. If empty, the default will be used.
-# html_search_scorer = 'scorer.js'
-
 # Output file base name for HTML help builder.
 htmlhelp_basename = "%sdoc" % module_nospace
 
 # -- Options for LaTeX output ---------------------------------------------
 
@@ -218,18 +95,9 @@
 # Output file base name for HTML help builder.
 htmlhelp_basename = "%sdoc" % module_nospace
 
 # -- Options for LaTeX output ---------------------------------------------
 
-latex_elements = {
-    # The paper size ('letterpaper' or 'a4paper').
-    #'papersize': 'letterpaper',
-    # The font size ('10pt', '11pt' or '12pt').
-    #'pointsize': '10pt',
-    # Additional stuff for the LaTeX preamble.
-    #'preamble': '',
-    # Latex figure (float) alignment
-    #'figure_align': 'htbp',
-}
+latex_elements = {}
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title,
@@ -244,27 +112,6 @@
     )
 ]
 
-# The name of an image file (relative to this directory) to place at the top of
-# the title page.
-# latex_logo = None
-
-# For "manual" documents, if this is true, then toplevel headings are parts,
-# not chapters.
-# latex_use_parts = False
-
-# If true, show page references after internal links.
-# latex_show_pagerefs = False
-
-# If true, show URL addresses after external links.
-# latex_show_urls = False
-
-# Documents to append as an appendix to all manuals.
-# latex_appendices = []
-
-# If false, no module index is generated.
-# latex_domain_indices = True
-
-
 # -- Options for manual page output ---------------------------------------
 
 # One entry per manual page. List of tuples
@@ -273,10 +120,6 @@
     (master_doc, module_lowercase, "%s Documentation" % project, [author], 1)
 ]
 
-# If true, show URL addresses after external links.
-# man_show_urls = False
-
-
 # -- Options for Texinfo output -------------------------------------------
 
 # Grouping the document tree into Texinfo files. List of tuples
@@ -294,18 +137,6 @@
     )
 ]
 
-# Documents to append as an appendix to all manuals.
-# texinfo_appendices = []
-
-# If false, no module index is generated.
-# texinfo_domain_indices = True
-
-# How to display URL addresses: 'footnote', 'no', or 'inline'.
-# texinfo_show_urls = 'footnote'
-
-# If true, do not generate a @detailmenu in the "Top" node's menu.
-# texinfo_no_detailmenu = False
-
 # Example configuration for intersphinx: refer to the Python standard library.
 intersphinx_mapping = {"https://docs.python.org/3/": None}
 
@@ -314,8 +145,9 @@
 # odoo-sphinx-autodoc
 #
 
-# sphinxodoo_addons: Names of addons to load
+# sphinxodoo_addons: List of addons name to load (if empty, no addon will be
+# loaded)
 this_module = os.path.basename(
     os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
 )
 sphinxodoo_addons = [this_module]
@@ -318,8 +150,8 @@
 this_module = os.path.basename(
     os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
 )
 sphinxodoo_addons = [this_module]
-# sphinxodoo_root_path: Path of the Odoo root directory
+# sphinxodoo_root_path : Path of the Odoo root directory
 sphinxodoo_root_path = os.path.dirname(
     os.path.dirname(os.path.abspath(odoo.__file__))
 )
@@ -323,11 +155,20 @@
 sphinxodoo_root_path = os.path.dirname(
     os.path.dirname(os.path.abspath(odoo.__file__))
 )
-# sphinxodoo_addons_path: List of paths were Odoo addons to load are located
-superproject_path = os.path.dirname(
-    os.path.dirname(os.path.dirname(os.getenv("PWD")))
-)
-c = configparser.ConfigParser()
-c.read(os.path.join(superproject_path, "setup.cfg"))
-sphinxodoo_addons_path = []
+# sphinxodoo_addons_path : List of paths were Odoo addons to load are located
+c = None
+# find setup file of superproject, if any
+directory = os.path.dirname(os.getenv("PWD"))
+while not c and directory:
+    setup_path = os.path.join(directory, "setup.cfg")
+    if os.path.isfile(setup_path):
+        c = configparser.ConfigParser()
+        c.read(setup_path)
+        if not c.has_section("odoo_scripts"):
+            c = None
+    if not c:
+        if os.path.dirname(directory) != directory:
+            directory = os.path.dirname(directory)
+        else:
+            directory = None
 
@@ -333,5 +174,3 @@
 
-addon_dirs = set(
-    os.path.dirname(path) for path in c.get("odoo_scripts", "modules").split()
-)
+sphinxodoo_addons_path = list()
 
@@ -337,3 +176,9 @@
 
-for line in addon_dirs:
-    sphinxodoo_addons_path.append(os.path.join(superproject_path, line))
+if c:
+    addon_dirs = set(
+        os.path.dirname(path)
+        for path in c.get("odoo_scripts", "modules").split()
+    )
+
+    for line in addon_dirs:
+        sphinxodoo_addons_path.append(os.path.join(directory, line))

doc/index.rst

@@ -7,7 +7,7 @@
 
    README
    modules
-   HISTORY
+   NEWS
    TODO
 
 Indices and tables