Skip to content

Commit 5bd7b70

Browse files
committed
disable extension to use xml-rpc to find pypi package names
The XML-RPC interface is discontinued, so stop using it by default.
1 parent d895656 commit 5bd7b70

File tree

2 files changed

+78
-55
lines changed

2 files changed

+78
-55
lines changed

docs/source/conf.py

Lines changed: 65 additions & 55 deletions
Original file line numberDiff line numberDiff line change
@@ -14,211 +14,221 @@
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('.'))
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'
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.
2626
extensions = [
27-
'sphinxcontrib.spelling',
27+
"sphinxcontrib.spelling",
2828
]
2929

3030
spelling_word_list_filename = [
31-
'spelling_wordlist.txt',
31+
"spelling_wordlist.txt",
3232
]
3333

3434
spelling_show_suggestions = True
35-
spelling_ignore_pypi_package_names = True
35+
spelling_ignore_pypi_package_names = False
3636
spelling_ignore_contributor_names = True
3737

3838
# Add any paths that contain templates here, relative to this directory.
39-
templates_path = ['_templates']
39+
templates_path = ["_templates"]
4040

4141
# The suffix of source filenames.
42-
source_suffix = '.rst'
42+
source_suffix = ".rst"
4343

4444
# The encoding of source files.
45-
#source_encoding = 'utf-8-sig'
45+
# source_encoding = 'utf-8-sig'
4646

4747
# The master toctree document.
48-
master_doc = 'index'
48+
master_doc = "index"
4949

5050
# General information about the project.
51-
project = 'sphinxcontrib.spelling'
52-
copyright = '2011, Doug Hellmann'
51+
project = "sphinxcontrib.spelling"
52+
copyright = "2011, Doug Hellmann"
5353

5454
# The version info for the project you're documenting, acts as replacement for
5555
# |version| and |release|, also used in various other places throughout the
5656
# built documents.
5757
#
5858
# The short X.Y version.
59-
version = '1.4'
59+
version = "1.4"
6060
# The full version, including alpha/beta/rc tags.
6161
release = version
6262

6363
# The language for content autogenerated by Sphinx. Refer to documentation
6464
# for a list of supported languages.
65-
language = 'en'
65+
language = "en"
6666

6767
# There are two options for replacing |today|: either, you set today to some
6868
# non-false value, then it is used:
69-
#today = ''
69+
# today = ''
7070
# Else, today_fmt is used as the format for a strftime call.
71-
#today_fmt = '%B %d, %Y'
71+
# today_fmt = '%B %d, %Y'
7272

7373
# List of patterns, relative to source directory, that match files and
7474
# directories to ignore when looking for source files.
7575
exclude_patterns = []
7676

7777
# The reST default role (used for this markup: `text`) to use for all documents.
78-
#default_role = None
78+
# default_role = None
7979

8080
# If true, '()' will be appended to :func: etc. cross-reference text.
81-
#add_function_parentheses = True
81+
# add_function_parentheses = True
8282

8383
# If true, the current module name will be prepended to all description
8484
# unit titles (such as .. function::).
85-
#add_module_names = True
85+
# add_module_names = True
8686

8787
# If true, sectionauthor and moduleauthor directives will be shown in the
8888
# output. They are ignored by default.
89-
#show_authors = False
89+
# show_authors = False
9090

9191
# The name of the Pygments (syntax highlighting) style to use.
92-
pygments_style = 'sphinx'
92+
pygments_style = "sphinx"
9393

9494
# A list of ignored prefixes for module index sorting.
95-
#modindex_common_prefix = []
95+
# modindex_common_prefix = []
9696

9797

9898
# -- Options for HTML output ---------------------------------------------------
9999

100100
# The theme to use for HTML and HTML Help pages. See the documentation for
101101
# a list of builtin themes.
102-
html_theme = 'default'
102+
html_theme = "default"
103103

104104
# Theme options are theme-specific and customize the look and feel of a theme
105105
# further. For a list of options available for each theme, see the
106106
# documentation.
107-
#html_theme_options = {}
107+
# html_theme_options = {}
108108

109109
# Add any paths that contain custom themes here, relative to this directory.
110-
#html_theme_path = []
110+
# html_theme_path = []
111111

112112
# The name for this set of Sphinx documents. If None, it defaults to
113113
# "<project> v<release> documentation".
114-
#html_title = None
114+
# html_title = None
115115

116116
# A shorter title for the navigation bar. Default is the same as html_title.
117-
#html_short_title = None
117+
# html_short_title = None
118118

119119
# The name of an image file (relative to this directory) to place at the top
120120
# of the sidebar.
121-
#html_logo = None
121+
# html_logo = None
122122

123123
# The name of an image file (within the static path) to use as favicon of the
124124
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
125125
# pixels large.
126-
#html_favicon = None
126+
# html_favicon = None
127127

128128
# Add any paths that contain custom static files (such as style sheets) here,
129129
# relative to this directory. They are copied after the builtin static files,
130130
# so a file named "default.css" will overwrite the builtin "default.css".
131-
#html_static_path = ['_static']
131+
# html_static_path = ['_static']
132132

133133
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
134134
# using the given strftime format.
135-
#html_last_updated_fmt = '%b %d, %Y'
135+
# html_last_updated_fmt = '%b %d, %Y'
136136

137137
# If true, SmartyPants will be used to convert quotes and dashes to
138138
# typographically correct entities.
139-
#html_use_smartypants = True
139+
# html_use_smartypants = True
140140

141141
# Custom sidebar templates, maps document names to template names.
142-
#html_sidebars = {}
142+
# html_sidebars = {}
143143

144144
# Additional templates that should be rendered to pages, maps page names to
145145
# template names.
146-
#html_additional_pages = {}
146+
# html_additional_pages = {}
147147

148148
# If false, no module index is generated.
149-
#html_domain_indices = True
149+
# html_domain_indices = True
150150

151151
# If false, no index is generated.
152-
#html_use_index = True
152+
# html_use_index = True
153153

154154
# If true, the index is split into individual pages for each letter.
155-
#html_split_index = False
155+
# html_split_index = False
156156

157157
# If true, links to the reST sources are added to the pages.
158-
#html_show_sourcelink = True
158+
# html_show_sourcelink = True
159159

160160
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
161-
#html_show_sphinx = True
161+
# html_show_sphinx = True
162162

163163
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
164-
#html_show_copyright = True
164+
# html_show_copyright = True
165165

166166
# If true, an OpenSearch description file will be output, and all pages will
167167
# contain a <link> tag referring to it. The value of this option must be the
168168
# base URL from which the finished HTML is served.
169-
#html_use_opensearch = ''
169+
# html_use_opensearch = ''
170170

171171
# This is the file name suffix for HTML files (e.g. ".xhtml").
172-
#html_file_suffix = None
172+
# html_file_suffix = None
173173

174174
# Output file base name for HTML help builder.
175-
htmlhelp_basename = 'sphinxcontribspellingdoc'
175+
htmlhelp_basename = "sphinxcontribspellingdoc"
176176

177177

178178
# -- Options for LaTeX output --------------------------------------------------
179179

180180
# The paper size ('letter' or 'a4').
181-
#latex_paper_size = 'letter'
181+
# latex_paper_size = 'letter'
182182

183183
# The font size ('10pt', '11pt' or '12pt').
184-
#latex_font_size = '10pt'
184+
# latex_font_size = '10pt'
185185

186186
# Grouping the document tree into LaTeX files. List of tuples
187187
# (source start file, target name, title, author, documentclass [howto/manual]).
188188
latex_documents = [
189-
('index', 'sphinxcontribspelling.tex', 'sphinxcontrib.spelling Documentation',
190-
'Doug Hellmann', 'manual'),
189+
(
190+
"index",
191+
"sphinxcontribspelling.tex",
192+
"sphinxcontrib.spelling Documentation",
193+
"Doug Hellmann",
194+
"manual",
195+
),
191196
]
192197

193198
# The name of an image file (relative to this directory) to place at the top of
194199
# the title page.
195-
#latex_logo = None
200+
# latex_logo = None
196201

197202
# For "manual" documents, if this is true, then toplevel headings are parts,
198203
# not chapters.
199-
#latex_use_parts = False
204+
# latex_use_parts = False
200205

201206
# If true, show page references after internal links.
202-
#latex_show_pagerefs = False
207+
# latex_show_pagerefs = False
203208

204209
# If true, show URL addresses after external links.
205-
#latex_show_urls = False
210+
# latex_show_urls = False
206211

207212
# Additional stuff for the LaTeX preamble.
208-
#latex_preamble = ''
213+
# latex_preamble = ''
209214

210215
# Documents to append as an appendix to all manuals.
211-
#latex_appendices = []
216+
# latex_appendices = []
212217

213218
# If false, no module index is generated.
214-
#latex_domain_indices = True
219+
# latex_domain_indices = True
215220

216221

217222
# -- Options for manual page output --------------------------------------------
218223

219224
# One entry per manual page. List of tuples
220225
# (source start file, name, description, authors, manual section).
221226
man_pages = [
222-
('index', 'sphinxcontribspelling', 'sphinxcontrib.spelling Documentation',
223-
['Doug Hellmann'], 1)
227+
(
228+
"index",
229+
"sphinxcontribspelling",
230+
"sphinxcontrib.spelling Documentation",
231+
["Doug Hellmann"],
232+
1,
233+
)
224234
]

docs/source/history.rst

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,24 @@
44

55
.. spelling:word-list::
66
7+
arg
8+
commandline
9+
config
10+
docstring
11+
emacs
12+
env
713
Homebrew
814
libenchant
915
macOS
16+
namespace
17+
pbr
18+
pyenchant
19+
repo
1020
scm
1121
setuptools
22+
testrepository
23+
tox
24+
unicode
1225
unmaintained
1326

1427
Next

0 commit comments

Comments
 (0)