fix: Use working config from python-amazon-sp-api (import module, add napoleon)

Author: denisneuf

docs/conf.py

@@ -18,9 +18,16 @@
 #
 import os
 import sys
+import inspect
 
 sys.path.insert(0, os.path.abspath('..'))
 
+currentdir = os.path.dirname(os.path.abspath(inspect.getfile(inspect.currentframe())))
+parentdir = os.path.dirname(currentdir)
+sys.path.insert(0, parentdir)
+
+# Importar el módulo principal - ¡ESTO ES CLAVE!
+import ad_api
 
 # -- General configuration ------------------------------------------------
 
@@ -31,22 +38,25 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ['sphinx.ext.autodoc', 'sphinx_rtd_theme']
-
-# Mockear importaciones problemáticas para que autodoc funcione
-autodoc_mock_imports = [
-    "requests",
-    "cachetools", 
-    "pycryptodome",
-    "pytz",
-    "confuse",
-    "six",
-    "python-dotenv",
-    "pyyaml",
-    # El paquete principal se mockea como respaldo
-    "ad_api",
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.napoleon',  # ¡IMPORTANTE para docstrings estilo Google!
+    'sphinx_rtd_theme'
 ]
 
+# Configuración de autodoc (como en el repo que funciona)
+autodoc_default_options = {
+    "members": True,
+    "undoc-members": True,
+    "member-order": "bysource"
+}
+
+# Configuración de napoleon para docstrings estilo Google
+napoleon_google_docstring = True
+napoleon_numpy_docstring = False
+napoleon_include_init_with_doc = True
+napoleon_include_private_with_doc = False
+napoleon_include_special_with_doc = True
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -68,17 +78,17 @@
 
 # General information about the project.
 project = u'Python Amazon Advertising API'
-copyright = u'2022, DAC'
-author = u'DAC'
+copyright = u'2023, Daniel Alvaro'
+author = u'Daniel Alvaro'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = u'0.4.3'
+version = u'0.7.4'
 # The full version, including alpha/beta/rc tags.
-release = u'0.4.3'
+release = u'0.7.4'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -99,21 +109,22 @@
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
 # This patterns also effect to html_static_path and html_extra_path
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', 'ad_api/base/*.py']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 
 # 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.
+# If true, '()' will be appended to :param: and :param type: in function
+# descriptions.
 #
-# add_function_parentheses = True
+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
+add_module_names = True
 
 # If true, sectionauthor and moduleauthor directives will be shown in the
 # output. They are ignored by default.
@@ -133,34 +144,11 @@
 todo_include_todos = False
 
 
-
-# -- Configuración adicional para autodoc --
-
-# Configuración adicional para autodoc con decoradores
-autodoc_default_options = {
-    "members": True,
-    "member-order": "bysource",
-    "special-members": "__init__",
-    "undoc-members": True,
-    "exclude-members": "__weakref__"
-}
-
-# Importante para métodos decorados
-autodoc_inherit_docstrings = True
-
-# Para preservar signatures con decoradores
-autodoc_preserve_defaults = True
-
-# Configurar cómo se muestran los type hints
-autodoc_typehints = "signature"
-autodoc_typehints_format = "short"
-
 # -- Options for HTML output ----------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
 #
-# html_theme = 'haiku'
 html_theme = 'sphinx_rtd_theme'
 
 # Theme options are theme-specific and customize the look and feel of a theme
@@ -172,24 +160,20 @@
 # Add any paths that contain custom themes here, relative to this directory.
 # html_theme_path = []
 
-# The name for this set of Sphinx documents.
-# "<project> v<release> documentation" by default.
-#
-# html_title = u'autodoc-example v0.1'
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+html_title = u'Python Amazon Advertising API v0.7.4'
 
 # 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
+# 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,
@@ -200,57 +184,44 @@
 # 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 None, a 'Last updated on:' timestamp is inserted at every page
 # bottom, using the given strftime format.
-# The empty string is equivalent to '%b %d, %Y'.
-#
 # html_last_updated_fmt = None
 
 # 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.
-#
+# base URL from which the finished documentation is served.
 # html_use_opensearch = ''
 
 # This is the file name suffix for HTML files (e.g. ".xhtml").
@@ -260,35 +231,33 @@
 # Sphinx supports the following languages:
 #   'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
 #   'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr', 'zh'
-#
 # html_search_language = 'en'
 
 # A dictionary with options for the search language support, empty by default.
-# 'ja' uses this config value.
-# 'zh' user can custom change `jieba` dictionary path.
-#
 # 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 = 'autodoc-exampledoc'
+htmlhelp_basename = 'python-amazon-ad-apidoc'
 
 # -- 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',
@@ -298,52 +267,41 @@
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'autodoc-example.tex', u'autodoc-example Documentation', u'Eric Beahan', 'manual'),
+    (master_doc, 'python-amazon-ad-api.tex', u'Python Amazon Advertising API Documentation',
+     u'Daniel Alvaro', 'manual'),
 ]
 
 # 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 = []
 
-# It false, will not define \strong, \code, \titleref, \crossref ... but only
-# \sphinxstrong, ..., \sphinxtitleref, ... To help avoid clash with user added
-# packages.
-#
-# latex_keep_old_macro_names = True
-
 # If false, no module index is generated.
-#
 # latex_domain_indices = True
 
 
 # -- Options for manual page output ---------------------------------------
 
-html_style = 'css/custom.css'
-
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [(master_doc, 'autodoc-example', u'autodoc-example Documentation', [author], 1)]
+man_pages = [
+    (master_doc, 'python-amazon-ad-api', u'Python Amazon Advertising API Documentation',
+     [author], 1)
+]
 
 # If true, show URL addresses after external links.
-#
 # man_show_urls = False
 
 
@@ -353,29 +311,19 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (
-        master_doc,
-        'autodoc-example',
-        u'autodoc-example Documentation',
-        author,
-        'autodoc-example',
-        'One line description of project.',
-        'Miscellaneous',
-    ),
+    (master_doc, 'python-amazon-ad-api', u'Python Amazon Advertising API Documentation',
+     author, 'python-amazon-ad-api', 'Python wrapper for the Amazon Advertising API.',
+     'Miscellaneous'),
 ]
 
 # 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