From 2747e02e68082e9a97349490491f02b7708b5d0f Mon Sep 17 00:00:00 2001 From: Bruno Alla Date: Tue, 31 Dec 2024 11:51:30 +0000 Subject: [PATCH] Exclude docs and revert most changes from Ruff --- docs/conf.py | 90 +++++++++++++++++++++++++------------------------- pyproject.toml | 1 + 2 files changed, 46 insertions(+), 45 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 5154fbe620..1b057bb4d1 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -9,17 +9,17 @@ # serve to show the default. from datetime import datetime -now = datetime.now() # noqa: DTZ005 +now = datetime.now() # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the # documentation root, use os.path.abspath to make it absolute, like shown here. -# sys.path.insert(0, os.path.abspath('.')) # noqa: ERA001 +# sys.path.insert(0, os.path.abspath('.')) # -- General configuration ----------------------------------------------------- # If your documentation needs a minimal Sphinx version, state it here. -# needs_sphinx = '1.0' # noqa: ERA001 +# 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. @@ -35,14 +35,14 @@ } # The encoding of source files. -# source_encoding = 'utf-8-sig' # noqa: ERA001 +# source_encoding = 'utf-8-sig' # The master toctree document. master_doc = "index" # General information about the project. project = "Cookiecutter Django" -copyright = f"2013-{now.year}, Daniel Roy Greenfeld" # noqa: A001 +copyright = f"2013-{now.year}, Daniel Roy Greenfeld" # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -55,37 +55,37 @@ # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -# language = None # noqa: ERA001 +# language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: -# today = '' # noqa: ERA001 +# today = '' # Else, today_fmt is used as the format for a strftime call. -# today_fmt = '%B %d, %Y' # noqa: ERA001 +# 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"] # The reST default role (used for this markup: `text`) to use for all documents. -# default_role = None # noqa: ERA001 +# default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. -# add_function_parentheses = True # noqa: ERA001 +# 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 # noqa: ERA001 +# add_module_names = True # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. -# show_authors = False # noqa: ERA001 +# show_authors = False # 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 = [] # noqa: ERA001 +# modindex_common_prefix = [] # -- Options for HTML output --------------------------------------------------- @@ -97,26 +97,26 @@ # 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 = {} # noqa: ERA001 +# html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. -# html_theme_path = [] # noqa: ERA001 +# html_theme_path = [] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". -# html_title = None # noqa: ERA001 +# html_title = None # A shorter title for the navigation bar. Default is the same as html_title. -# html_short_title = None # noqa: ERA001 +# 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 # noqa: ERA001 +# html_logo = None # The name of an image file (within the static path) to use as favicon of the # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 # pixels large. -# html_favicon = None # noqa: ERA001 +# 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, @@ -125,44 +125,44 @@ # 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' # noqa: ERA001 +# 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 # noqa: ERA001 +# html_use_smartypants = True # Custom sidebar templates, maps document names to template names. -# html_sidebars = {} # noqa: ERA001 +# html_sidebars = {} # Additional templates that should be rendered to pages, maps page names to # template names. -# html_additional_pages = {} # noqa: ERA001 +# html_additional_pages = {} # If false, no module index is generated. -# html_domain_indices = True # noqa: ERA001 +# html_domain_indices = True # If false, no index is generated. -# html_use_index = True # noqa: ERA001 +# html_use_index = True # If true, the index is split into individual pages for each letter. -# html_split_index = False # noqa: ERA001 +# html_split_index = False # If true, links to the reST sources are added to the pages. -# html_show_sourcelink = True # noqa: ERA001 +# html_show_sourcelink = True # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. -# html_show_sphinx = True # noqa: ERA001 +# html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -# html_show_copyright = True # noqa: ERA001 +# html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the # base URL from which the finished HTML is served. -# html_use_opensearch = '' # noqa: ERA001 +# html_use_opensearch = '' # This is the file name suffix for HTML files (e.g. ".xhtml"). -# html_file_suffix = None # noqa: ERA001 +# html_file_suffix = None # Output file base name for HTML help builder. htmlhelp_basename = "cookiecutter-djangodoc" @@ -172,11 +172,11 @@ latex_elements = { # The paper size ('letterpaper' or 'a4paper'). - # 'papersize': 'letterpaper', # noqa: ERA001 + # 'papersize': 'letterpaper', # The font size ('10pt', '11pt' or '12pt'). - # 'pointsize': '10pt', # noqa: ERA001 + # 'pointsize': '10pt', # Additional stuff for the LaTeX preamble. - # 'preamble': '', # noqa: ERA001 + # 'preamble': '', } # Grouping the document tree into LaTeX files. List of tuples @@ -193,23 +193,23 @@ # The name of an image file (relative to this directory) to place at the top of # the title page. -# latex_logo = None # noqa: ERA001 +# latex_logo = None # For "manual" documents, if this is true, then toplevel headings are parts, # not chapters. -# latex_use_parts = False # noqa: ERA001 +# latex_use_parts = False # If true, show page references after internal links. -# latex_show_pagerefs = False # noqa: ERA001 +# latex_show_pagerefs = False # If true, show URL addresses after external links. -# latex_show_urls = False # noqa: ERA001 +# latex_show_urls = False # Documents to append as an appendix to all manuals. -# latex_appendices = [] # noqa: ERA001 +# latex_appendices = [] # If false, no module index is generated. -# latex_domain_indices = True # noqa: ERA001 +# latex_domain_indices = True # -- Options for manual page output -------------------------------------------- @@ -227,7 +227,7 @@ ] # If true, show URL addresses after external links. -# man_show_urls = False # noqa: ERA001 +# man_show_urls = False # -- Options for Texinfo output ------------------------------------------------ @@ -244,14 +244,14 @@ "Cookiecutter Django", "A Cookiecutter template for creating production-ready Django projects quickly.", "Miscellaneous", - ), + ) ] # Documents to append as an appendix to all manuals. -# texinfo_appendices = [] # noqa: ERA001 +# texinfo_appendices = [] # If false, no module index is generated. -# texinfo_domain_indices = True # noqa: ERA001 +# texinfo_domain_indices = True # How to display URL addresses: 'footnote', 'no', or 'inline'. -# texinfo_show_urls = 'footnote' # noqa: ERA001 +# texinfo_show_urls = 'footnote' diff --git a/pyproject.toml b/pyproject.toml index 8c7b2f5c50..f4265023fc 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -64,6 +64,7 @@ line-length = 119 # Exclude the template content as most files aren't parseable extend-exclude = [ "[{]{2}cookiecutter.project_slug[}]{2}/*", + "docs/*", ] lint.select = [