Less warnings, more?

Signed-off-by: Krzysztof Lecki <klecki@nvidia.com>
NVIDIA · Apr 7, 2022 · db4686e · db4686e
1 parent 9c47968
commit db4686e
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 7 deletions.
diff --git a/dali/operators/signal/decibel/to_decibels_op_cpu.cc b/dali/operators/signal/decibel/to_decibels_op_cpu.cc
@@ -20,8 +20,9 @@
 namespace dali {
 
 DALI_SCHEMA(ToDecibels)
-    .DocStr(R"code(Converts a magnitude (real, positive) to the decibel scale by using
-the following formula::
+    .DocStr(R"code(Converts a magnitude (real, positive) to the decibel scale.
+
+Conversion is done according to the following formula::
 
   min_ratio = pow(10, cutoff_db / multiplier)
   out[i] = multiplier * log10( max(min_ratio, input[i] / reference) ))code")

diff --git a/docs/autodoc_submodules.py b/docs/autodoc_submodules.py
@@ -96,8 +96,7 @@ def get_references(name, references):
 def single_fun_file(full_name, references):
     """Generate stub page for documentation of given function from fn api.
     """
-    result = ""
-    result += f".. _{full_name}:\n\n{full_name}\n"
+    result = f"{full_name}\n"
     result += "-" * len(full_name) + "\n\n"
     result += f".. autofunction:: {full_name}\n\n"
     result += get_references(full_name, references)
@@ -106,16 +105,17 @@ def single_fun_file(full_name, references):
 def single_module_file(module, funs_in_module, references):
     """Generate stub page for documentation of given module
     """
-    result = ""
-    result += f".. _{module}:\n\n{module}\n"
+    result = f"{module}\n"
     result += "~" * len(module) + "\n\n"
 
     if module in mod_aditional_doc:
         result += mod_aditional_doc[module] + "\n\n"
     result += get_references(module, references)
+    result += "\n"
 
     result += f"The following table lists all operations available in ``{module}`` module:\n"
     result += operations_table.operations_table_str(get_schema_names(module, funs_in_module))
+    result += "\n\n"
 
 
     result += ".. toctree::\n   :hidden:\n\n"

diff --git a/docs/operations_table.py b/docs/operations_table.py
@@ -121,7 +121,7 @@ def operations_table_str(ops_to_process):
             full_doc = schema.Dox()
         else:
             full_doc = eval('ops.' + op).__doc__
-        short_descr = full_doc.split("\n\n")[0].replace('\n', ' ')
+        short_descr = full_doc.split("\n\n")[0].replace('\n', ' ').replace("::", '.')
         for (module_name, module) in ops_modules.items():
             m = module
             for part in submodule: