Format the codebase using Black (#2109)
This commit: 1. Formats all of our existing code using `black`. 2. Adds a note about using `black` to `CONTRIBUTING.rst`. 3. Runs `black --check` as part of CI (failing builds that aren't properly formatted).
This commit is contained in:
		
							
								
								
									
										93
									
								
								docs/conf.py
									
									
									
									
									
								
							
							
						
						
									
										93
									
								
								docs/conf.py
									
									
									
									
									
								
							| @@ -20,29 +20,29 @@ import mongoengine | ||||
| # 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('..')) | ||||
| sys.path.insert(0, os.path.abspath("..")) | ||||
|  | ||||
| # -- General configuration ----------------------------------------------------- | ||||
|  | ||||
| # 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.ext.todo'] | ||||
| extensions = ["sphinx.ext.autodoc", "sphinx.ext.todo"] | ||||
|  | ||||
| # Add any paths that contain templates here, relative to this directory. | ||||
| templates_path = ['_templates'] | ||||
| templates_path = ["_templates"] | ||||
|  | ||||
| # The suffix of source filenames. | ||||
| source_suffix = '.rst' | ||||
| source_suffix = ".rst" | ||||
|  | ||||
| # The encoding of source files. | ||||
| #source_encoding = 'utf-8' | ||||
| # source_encoding = 'utf-8' | ||||
|  | ||||
| # The master toctree document. | ||||
| master_doc = 'index' | ||||
| master_doc = "index" | ||||
|  | ||||
| # General information about the project. | ||||
| project = u'MongoEngine' | ||||
| copyright = u'2009, MongoEngine Authors' | ||||
| project = u"MongoEngine" | ||||
| copyright = u"2009, MongoEngine Authors" | ||||
|  | ||||
| # 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,68 +55,66 @@ release = mongoengine.get_version() | ||||
|  | ||||
| # The language for content autogenerated by Sphinx. Refer to documentation | ||||
| # for a list of supported languages. | ||||
| #language = None | ||||
| # language = None | ||||
|  | ||||
| # There are two options for replacing |today|: either, you set today to some | ||||
| # non-false value, then it is used: | ||||
| #today = '' | ||||
| # today = '' | ||||
| # Else, today_fmt is used as the format for a strftime call. | ||||
| #today_fmt = '%B %d, %Y' | ||||
| # today_fmt = '%B %d, %Y' | ||||
|  | ||||
| # List of documents that shouldn't be included in the build. | ||||
| #unused_docs = [] | ||||
| # unused_docs = [] | ||||
|  | ||||
| # List of directories, relative to source directory, that shouldn't be searched | ||||
| # for source files. | ||||
| exclude_trees = ['_build'] | ||||
| exclude_trees = ["_build"] | ||||
|  | ||||
| # The reST default role (used for this markup: `text`) to use for all documents. | ||||
| #default_role = None | ||||
| # default_role = None | ||||
|  | ||||
| # If true, '()' will be appended to :func: etc. cross-reference text. | ||||
| #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. | ||||
| #show_authors = False | ||||
| # show_authors = False | ||||
|  | ||||
| # The name of the Pygments (syntax highlighting) style to use. | ||||
| pygments_style = 'sphinx' | ||||
| pygments_style = "sphinx" | ||||
|  | ||||
| # A list of ignored prefixes for module index sorting. | ||||
| #modindex_common_prefix = [] | ||||
| # modindex_common_prefix = [] | ||||
|  | ||||
|  | ||||
| # -- Options for HTML output --------------------------------------------------- | ||||
|  | ||||
| # The theme to use for HTML and HTML Help pages.  Major themes that come with | ||||
| # Sphinx are currently 'default' and 'sphinxdoc'. | ||||
| html_theme = 'sphinx_rtd_theme' | ||||
| html_theme = "sphinx_rtd_theme" | ||||
|  | ||||
| # 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 = { | ||||
|     'canonical_url': 'http://docs.mongoengine.org/en/latest/' | ||||
| } | ||||
| html_theme_options = {"canonical_url": "http://docs.mongoengine.org/en/latest/"} | ||||
|  | ||||
| # Add any paths that contain custom themes here, relative to this directory. | ||||
| html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] | ||||
|  | ||||
| # The name for this set of Sphinx documents.  If None, it defaults to | ||||
| # "<project> v<release> documentation". | ||||
| #html_title = None | ||||
| # html_title = None | ||||
|  | ||||
| # A shorter title for the navigation bar.  Default is the same as html_title. | ||||
| #html_short_title = None | ||||
| # 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 | ||||
| # 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 | ||||
| @@ -126,11 +124,11 @@ html_favicon = "favicon.ico" | ||||
| # 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, | ||||
| # so a file named "default.css" will overwrite the builtin "default.css". | ||||
| #html_static_path = ['_static'] | ||||
| # html_static_path = ['_static'] | ||||
|  | ||||
| # 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' | ||||
| # html_last_updated_fmt = '%b %d, %Y' | ||||
|  | ||||
| # If true, SmartyPants will be used to convert quotes and dashes to | ||||
| # typographically correct entities. | ||||
| @@ -138,69 +136,68 @@ html_use_smartypants = True | ||||
|  | ||||
| # Custom sidebar templates, maps document names to template names. | ||||
| html_sidebars = { | ||||
|     'index': ['globaltoc.html', 'searchbox.html'], | ||||
|     '**': ['localtoc.html', 'relations.html', 'searchbox.html'] | ||||
|     "index": ["globaltoc.html", "searchbox.html"], | ||||
|     "**": ["localtoc.html", "relations.html", "searchbox.html"], | ||||
| } | ||||
|  | ||||
|  | ||||
| # Additional templates that should be rendered to pages, maps page names to | ||||
| # template names. | ||||
| #html_additional_pages = {} | ||||
| # html_additional_pages = {} | ||||
|  | ||||
| # If false, no module index is generated. | ||||
| #html_use_modindex = True | ||||
| # html_use_modindex = True | ||||
|  | ||||
| # If false, no index is generated. | ||||
| #html_use_index = True | ||||
| # html_use_index = True | ||||
|  | ||||
| # If true, the index is split into individual pages for each letter. | ||||
| #html_split_index = False | ||||
| # html_split_index = False | ||||
|  | ||||
| # If true, links to the reST sources are added to the pages. | ||||
| #html_show_sourcelink = True | ||||
| # html_show_sourcelink = 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. | ||||
| #html_use_opensearch = '' | ||||
| # html_use_opensearch = '' | ||||
|  | ||||
| # If nonempty, this is the file name suffix for HTML files (e.g. ".xhtml"). | ||||
| #html_file_suffix = '' | ||||
| # html_file_suffix = '' | ||||
|  | ||||
| # Output file base name for HTML help builder. | ||||
| htmlhelp_basename = 'MongoEnginedoc' | ||||
| htmlhelp_basename = "MongoEnginedoc" | ||||
|  | ||||
|  | ||||
| # -- Options for LaTeX output -------------------------------------------------- | ||||
|  | ||||
| # The paper size ('letter' or 'a4'). | ||||
| latex_paper_size = 'a4' | ||||
| latex_paper_size = "a4" | ||||
|  | ||||
| # The font size ('10pt', '11pt' or '12pt'). | ||||
| #latex_font_size = '10pt' | ||||
| # latex_font_size = '10pt' | ||||
|  | ||||
| # Grouping the document tree into LaTeX files. List of tuples | ||||
| # (source start file, target name, title, author, documentclass [howto/manual]). | ||||
| latex_documents = [ | ||||
|   ('index', 'MongoEngine.tex', 'MongoEngine Documentation', | ||||
|    'Ross Lawley', 'manual'), | ||||
|     ("index", "MongoEngine.tex", "MongoEngine Documentation", "Ross Lawley", "manual") | ||||
| ] | ||||
|  | ||||
| # The name of an image file (relative to this directory) to place at the top of | ||||
| # the title page. | ||||
| #latex_logo = None | ||||
| # latex_logo = None | ||||
|  | ||||
| # For "manual" documents, if this is true, then toplevel headings are parts, | ||||
| # not chapters. | ||||
| #latex_use_parts = False | ||||
| # latex_use_parts = False | ||||
|  | ||||
| # Additional stuff for the LaTeX preamble. | ||||
| #latex_preamble = '' | ||||
| # latex_preamble = '' | ||||
|  | ||||
| # Documents to append as an appendix to all manuals. | ||||
| #latex_appendices = [] | ||||
| # latex_appendices = [] | ||||
|  | ||||
| # If false, no module index is generated. | ||||
| #latex_use_modindex = True | ||||
| # latex_use_modindex = True | ||||
|  | ||||
| autoclass_content = 'both' | ||||
| autoclass_content = "both" | ||||
|   | ||||
		Reference in New Issue
	
	Block a user