chore: Run postgrest-style on docs files

This prevents CI from failing after the merge.

docs/conf.py

@@ -28,38 +28,35 @@ import os
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = [
+extensions = ["sphinx_tabs.tabs", "sphinx_copybutton"]
-  'sphinx_tabs.tabs',
-  'sphinx_copybutton'
-]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix(es) of source filenames.
 # You can specify multiple suffix as a list of string:
 # source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The encoding of source files.
 # source_encoding = 'utf-8-sig'
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = u'PostgREST'
+project = "PostgREST"
-author = u'Joe Nelson, Steve Chavez'
+author = "Joe Nelson, Steve Chavez"
-copyright = u'2017, ' + author
+copyright = "2017, " + author
 
 # 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'11.1'
+version = "11.1"
 # The full version, including alpha/beta/rc tags.
-release = u'11.1.0'
+release = "11.1.0"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -77,7 +74,7 @@ language = None
 # 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']
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 # The reST default role (used for this markup: `text`) to use for all
 # documents.
@@ -95,7 +92,7 @@ exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
 # 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 = []
@@ -111,7 +108,7 @@ todo_include_todos = False
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-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
@@ -135,12 +132,12 @@ html_theme = 'sphinx_rtd_theme'
 # 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
 # pixels large.
-html_favicon = '_static/favicon.ico'
+html_favicon = "_static/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"]
 
 # Add any extra paths that contain custom files (such as robots.txt or
 # .htaccess) here, relative to this directory. These files are copied
@@ -205,20 +202,17 @@ html_static_path = ['_static']
 # html_search_scorer = 'scorer.js'
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'PostgRESTdoc'
+htmlhelp_basename = "PostgRESTdoc"
 
 # -- 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',
 }
@@ -227,8 +221,7 @@ latex_elements = {
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc, 'PostgREST.tex', u'PostgREST Documentation',
+    (master_doc, "PostgREST.tex", "PostgREST Documentation", author, "manual"),
-     author, 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -256,10 +249,7 @@ latex_documents = [
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [
+man_pages = [(master_doc, "postgrest", "PostgREST Documentation", [author], 1)]
-    (master_doc, 'postgrest', u'PostgREST Documentation',
-     [author], 1)
-]
 
 # If true, show URL addresses after external links.
 # man_show_urls = False
@@ -271,9 +261,15 @@ man_pages = [
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-    (master_doc, 'PostgREST', u'PostgREST Documentation',
+    (
-     author, 'PostgREST', 'REST API for any PostgreSQL database',
+        master_doc,
-     'Web'),
+        "PostgREST",
+        "PostgREST Documentation",
+        author,
+        "PostgREST",
+        "REST API for any PostgreSQL database",
+        "Web",
+    ),
 ]
 
 # Documents to append as an appendix to all manuals.
@@ -290,11 +286,13 @@ texinfo_documents = [
 
 # -- Custom setup ---------------------------------------------------------
 
+
 def setup(app):
-    app.add_css_file('css/custom.css')
+    app.add_css_file("css/custom.css")
+
 
 # taken from https://github.com/sphinx-doc/sphinx/blob/82dad44e5bd3776ecb6fd8ded656bc8151d0e63d/sphinx/util/requests.py#L42
-user_agent = 'Mozilla/5.0 (X11; Linux x86_64; rv:25.0) Gecko/20100101 Firefox/25.0'
+user_agent = "Mozilla/5.0 (X11; Linux x86_64; rv:25.0) Gecko/20100101 Firefox/25.0"
 
 # sphinx-tabs configuration
 sphinx_tabs_disable_tab_closing = True

docs/livereload_docs.py

@@ -1,10 +1,11 @@
 #!/usr/bin/env python
 from livereload import Server, shell
 from subprocess import call
+
 ## Build docs at startup
-call(['sphinx-build', '-b', 'html', '-a', '-n', '.', '_build'])
+call(["sphinx-build", "-b", "html", "-a", "-n", ".", "_build"])
 server = Server()
-server.watch('**/*.rst', shell('sphinx-build -b html -a -n . _build'))
+server.watch("**/*.rst", shell("sphinx-build -b html -a -n . _build"))
 # For custom port and host
 # server.serve(root='_build/', host='192.168.1.2')
-server.serve(root='_build/')
+server.serve(root="_build/")

docs/shell.nix

@@ -2,8 +2,7 @@ let
   docs =
     import ./default.nix;
 
-  pkgs =
+  inherit (docs) pkgs;
-    docs.pkgs;
 in
 pkgs.mkShell {
   name = "postgrest-docs";