Skip to content

Commit 2747e02

Browse files
committed
Exclude docs and revert most changes from Ruff
1 parent 2a6be9e commit 2747e02

File tree

2 files changed

+46
-45
lines changed

2 files changed

+46
-45
lines changed

docs/conf.py

+45-45
Original file line numberDiff line numberDiff line change
@@ -9,17 +9,17 @@
99
# serve to show the default.
1010
from datetime import datetime
1111

12-
now = datetime.now() # noqa: DTZ005
12+
now = datetime.now()
1313

1414
# If extensions (or modules to document with autodoc) are in another directory,
1515
# add these directories to sys.path here. If the directory is relative to the
1616
# documentation root, use os.path.abspath to make it absolute, like shown here.
17-
# sys.path.insert(0, os.path.abspath('.')) # noqa: ERA001
17+
# sys.path.insert(0, os.path.abspath('.'))
1818

1919
# -- General configuration -----------------------------------------------------
2020

2121
# If your documentation needs a minimal Sphinx version, state it here.
22-
# needs_sphinx = '1.0' # noqa: ERA001
22+
# needs_sphinx = '1.0'
2323

2424
# Add any Sphinx extension module names here, as strings. They can be extensions
2525
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
@@ -35,14 +35,14 @@
3535
}
3636

3737
# The encoding of source files.
38-
# source_encoding = 'utf-8-sig' # noqa: ERA001
38+
# source_encoding = 'utf-8-sig'
3939

4040
# The master toctree document.
4141
master_doc = "index"
4242

4343
# General information about the project.
4444
project = "Cookiecutter Django"
45-
copyright = f"2013-{now.year}, Daniel Roy Greenfeld" # noqa: A001
45+
copyright = f"2013-{now.year}, Daniel Roy Greenfeld"
4646

4747
# The version info for the project you're documenting, acts as replacement for
4848
# |version| and |release|, also used in various other places throughout the
@@ -55,37 +55,37 @@
5555

5656
# The language for content autogenerated by Sphinx. Refer to documentation
5757
# for a list of supported languages.
58-
# language = None # noqa: ERA001
58+
# language = None
5959

6060
# There are two options for replacing |today|: either, you set today to some
6161
# non-false value, then it is used:
62-
# today = '' # noqa: ERA001
62+
# today = ''
6363
# Else, today_fmt is used as the format for a strftime call.
64-
# today_fmt = '%B %d, %Y' # noqa: ERA001
64+
# today_fmt = '%B %d, %Y'
6565

6666
# List of patterns, relative to source directory, that match files and
6767
# directories to ignore when looking for source files.
6868
exclude_patterns = ["_build"]
6969

7070
# The reST default role (used for this markup: `text`) to use for all documents.
71-
# default_role = None # noqa: ERA001
71+
# default_role = None
7272

7373
# If true, '()' will be appended to :func: etc. cross-reference text.
74-
# add_function_parentheses = True # noqa: ERA001
74+
# add_function_parentheses = True
7575

7676
# If true, the current module name will be prepended to all description
7777
# unit titles (such as .. function::).
78-
# add_module_names = True # noqa: ERA001
78+
# add_module_names = True
7979

8080
# If true, sectionauthor and moduleauthor directives will be shown in the
8181
# output. They are ignored by default.
82-
# show_authors = False # noqa: ERA001
82+
# show_authors = False
8383

8484
# The name of the Pygments (syntax highlighting) style to use.
8585
pygments_style = "sphinx"
8686

8787
# A list of ignored prefixes for module index sorting.
88-
# modindex_common_prefix = [] # noqa: ERA001
88+
# modindex_common_prefix = []
8989

9090

9191
# -- Options for HTML output ---------------------------------------------------
@@ -97,26 +97,26 @@
9797
# Theme options are theme-specific and customize the look and feel of a theme
9898
# further. For a list of options available for each theme, see the
9999
# documentation.
100-
# html_theme_options = {} # noqa: ERA001
100+
# html_theme_options = {}
101101

102102
# Add any paths that contain custom themes here, relative to this directory.
103-
# html_theme_path = [] # noqa: ERA001
103+
# html_theme_path = []
104104

105105
# The name for this set of Sphinx documents. If None, it defaults to
106106
# "<project> v<release> documentation".
107-
# html_title = None # noqa: ERA001
107+
# html_title = None
108108

109109
# A shorter title for the navigation bar. Default is the same as html_title.
110-
# html_short_title = None # noqa: ERA001
110+
# html_short_title = None
111111

112112
# The name of an image file (relative to this directory) to place at the top
113113
# of the sidebar.
114-
# html_logo = None # noqa: ERA001
114+
# html_logo = None
115115

116116
# The name of an image file (within the static path) to use as favicon of the
117117
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
118118
# pixels large.
119-
# html_favicon = None # noqa: ERA001
119+
# html_favicon = None
120120

121121
# Add any paths that contain custom static files (such as style sheets) here,
122122
# relative to this directory. They are copied after the builtin static files,
@@ -125,44 +125,44 @@
125125

126126
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
127127
# using the given strftime format.
128-
# html_last_updated_fmt = '%b %d, %Y' # noqa: ERA001
128+
# html_last_updated_fmt = '%b %d, %Y'
129129

130130
# If true, SmartyPants will be used to convert quotes and dashes to
131131
# typographically correct entities.
132-
# html_use_smartypants = True # noqa: ERA001
132+
# html_use_smartypants = True
133133

134134
# Custom sidebar templates, maps document names to template names.
135-
# html_sidebars = {} # noqa: ERA001
135+
# html_sidebars = {}
136136

137137
# Additional templates that should be rendered to pages, maps page names to
138138
# template names.
139-
# html_additional_pages = {} # noqa: ERA001
139+
# html_additional_pages = {}
140140

141141
# If false, no module index is generated.
142-
# html_domain_indices = True # noqa: ERA001
142+
# html_domain_indices = True
143143

144144
# If false, no index is generated.
145-
# html_use_index = True # noqa: ERA001
145+
# html_use_index = True
146146

147147
# If true, the index is split into individual pages for each letter.
148-
# html_split_index = False # noqa: ERA001
148+
# html_split_index = False
149149

150150
# If true, links to the reST sources are added to the pages.
151-
# html_show_sourcelink = True # noqa: ERA001
151+
# html_show_sourcelink = True
152152

153153
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
154-
# html_show_sphinx = True # noqa: ERA001
154+
# html_show_sphinx = True
155155

156156
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
157-
# html_show_copyright = True # noqa: ERA001
157+
# html_show_copyright = True
158158

159159
# If true, an OpenSearch description file will be output, and all pages will
160160
# contain a <link> tag referring to it. The value of this option must be the
161161
# base URL from which the finished HTML is served.
162-
# html_use_opensearch = '' # noqa: ERA001
162+
# html_use_opensearch = ''
163163

164164
# This is the file name suffix for HTML files (e.g. ".xhtml").
165-
# html_file_suffix = None # noqa: ERA001
165+
# html_file_suffix = None
166166

167167
# Output file base name for HTML help builder.
168168
htmlhelp_basename = "cookiecutter-djangodoc"
@@ -172,11 +172,11 @@
172172

173173
latex_elements = {
174174
# The paper size ('letterpaper' or 'a4paper').
175-
# 'papersize': 'letterpaper', # noqa: ERA001
175+
# 'papersize': 'letterpaper',
176176
# The font size ('10pt', '11pt' or '12pt').
177-
# 'pointsize': '10pt', # noqa: ERA001
177+
# 'pointsize': '10pt',
178178
# Additional stuff for the LaTeX preamble.
179-
# 'preamble': '', # noqa: ERA001
179+
# 'preamble': '',
180180
}
181181

182182
# Grouping the document tree into LaTeX files. List of tuples
@@ -193,23 +193,23 @@
193193

194194
# The name of an image file (relative to this directory) to place at the top of
195195
# the title page.
196-
# latex_logo = None # noqa: ERA001
196+
# latex_logo = None
197197

198198
# For "manual" documents, if this is true, then toplevel headings are parts,
199199
# not chapters.
200-
# latex_use_parts = False # noqa: ERA001
200+
# latex_use_parts = False
201201

202202
# If true, show page references after internal links.
203-
# latex_show_pagerefs = False # noqa: ERA001
203+
# latex_show_pagerefs = False
204204

205205
# If true, show URL addresses after external links.
206-
# latex_show_urls = False # noqa: ERA001
206+
# latex_show_urls = False
207207

208208
# Documents to append as an appendix to all manuals.
209-
# latex_appendices = [] # noqa: ERA001
209+
# latex_appendices = []
210210

211211
# If false, no module index is generated.
212-
# latex_domain_indices = True # noqa: ERA001
212+
# latex_domain_indices = True
213213

214214

215215
# -- Options for manual page output --------------------------------------------
@@ -227,7 +227,7 @@
227227
]
228228

229229
# If true, show URL addresses after external links.
230-
# man_show_urls = False # noqa: ERA001
230+
# man_show_urls = False
231231

232232

233233
# -- Options for Texinfo output ------------------------------------------------
@@ -244,14 +244,14 @@
244244
"Cookiecutter Django",
245245
"A Cookiecutter template for creating production-ready Django projects quickly.",
246246
"Miscellaneous",
247-
),
247+
)
248248
]
249249

250250
# Documents to append as an appendix to all manuals.
251-
# texinfo_appendices = [] # noqa: ERA001
251+
# texinfo_appendices = []
252252

253253
# If false, no module index is generated.
254-
# texinfo_domain_indices = True # noqa: ERA001
254+
# texinfo_domain_indices = True
255255

256256
# How to display URL addresses: 'footnote', 'no', or 'inline'.
257-
# texinfo_show_urls = 'footnote' # noqa: ERA001
257+
# texinfo_show_urls = 'footnote'

pyproject.toml

+1
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ line-length = 119
6464
# Exclude the template content as most files aren't parseable
6565
extend-exclude = [
6666
"[{]{2}cookiecutter.project_slug[}]{2}/*",
67+
"docs/*",
6768
]
6869

6970
lint.select = [

0 commit comments

Comments
 (0)