Remove module titles in docstrings

AA-Turner · AA-Turner · commit b6925aa9314b · 2023-08-07T19:47:11.000+01:00
diff --git a/sphinxcontrib/websupport/__init__.py b/sphinxcontrib/websupport/__init__.py
@@ -1,14 +1,4 @@
-# -*- coding: utf-8 -*-
-"""
-    sphinxcontrib.websupport
-    ~~~~~~~~~~~~~~~~~~~~~~~~
-
-    A Python API to easily integrate Sphinx documentation into Web
-    applications.
-
-    :copyright: Copyright 2007-2018 by the Sphinx team, see README.
-    :license: BSD, see LICENSE for details.
-"""
+"""A Python API to easily integrate Sphinx documentation into Web applications."""
 from os import path
 
 
diff --git a/sphinxcontrib/websupport/builder.py b/sphinxcontrib/websupport/builder.py
@@ -1,13 +1,4 @@
-# -*- coding: utf-8 -*-
-"""
-    sphinx.builders.websupport
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-    Builder for the web support package.
-
-    :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
+"""Builder for the web support extension."""
 
 from __future__ import annotations
 
diff --git a/sphinxcontrib/websupport/core.py b/sphinxcontrib/websupport/core.py
@@ -1,13 +1,4 @@
-# -*- coding: utf-8 -*-
-"""
-    sphinxcontrib.websupport.core
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-    Base Module for web support functions.
-
-    :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
+"""Base Module for web support functions."""
 
 from __future__ import annotations
 
diff --git a/sphinxcontrib/websupport/errors.py b/sphinxcontrib/websupport/errors.py
@@ -1,13 +1,4 @@
-# -*- coding: utf-8 -*-
-"""
-    sphinxcontrib.websupport.errors
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-    Contains Error classes for the web support package.
-
-    :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
+"""Contains Error classes for the web support package."""
 
 
 class DocumentNotFoundError(Exception):
diff --git a/sphinxcontrib/websupport/search/__init__.py b/sphinxcontrib/websupport/search/__init__.py
@@ -1,13 +1,4 @@
-# -*- coding: utf-8 -*-
-"""
-    sphinxcontrib.websupport.search
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-    Server side search support for the web support package.
-
-    :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
+"""Server side search support for the web support package."""
 
 import re
 
diff --git a/sphinxcontrib/websupport/search/nullsearch.py b/sphinxcontrib/websupport/search/nullsearch.py
@@ -1,13 +1,4 @@
-# -*- coding: utf-8 -*-
-"""
-    sphinxcontrib.websupport.search.nullsearch
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-    The default search adapter, does nothing.
-
-    :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
+"""The default search adapter, does nothing."""
 
 from sphinxcontrib.websupport.search import BaseSearch
 from sphinxcontrib.websupport.errors import NullSearchException
diff --git a/sphinxcontrib/websupport/search/whooshsearch.py b/sphinxcontrib/websupport/search/whooshsearch.py
@@ -1,13 +1,4 @@
-# -*- coding: utf-8 -*-
-"""
-    sphinxcontrib.websupport.search.whooshsearch
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-    Whoosh search adapter.
-
-    :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
+"""Whoosh search adapter."""
 
 from whoosh import index
 from whoosh.fields import Schema, ID, TEXT
diff --git a/sphinxcontrib/websupport/search/xapiansearch.py b/sphinxcontrib/websupport/search/xapiansearch.py
@@ -1,13 +1,4 @@
-# -*- coding: utf-8 -*-
-"""
-    sphinxcontrib.websupport.search.xapiansearch
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-    Xapian search adapter.
-
-    :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
+"""Xapian search adapter."""
 
 import xapian
 
diff --git a/sphinxcontrib/websupport/storage/__init__.py b/sphinxcontrib/websupport/storage/__init__.py
@@ -1,13 +1,4 @@
-# -*- coding: utf-8 -*-
-"""
-    sphinxcontrib.websupport.storage
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-    Storage for the websupport package.
-
-    :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
+"""Storage for the websupport package."""
 
 
 class StorageBackend(object):
diff --git a/sphinxcontrib/websupport/storage/differ.py b/sphinxcontrib/websupport/storage/differ.py
@@ -1,13 +1,4 @@
-# -*- coding: utf-8 -*-
-"""
-    sphinxcontrib.websupport.storage.differ
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-    A differ for creating an HTML representations of proposal diffs
-
-    :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
+"""A differ for creating an HTML representations of proposal diffs."""
 
 import html
 import re
diff --git a/sphinxcontrib/websupport/storage/sqlalchemy_db.py b/sphinxcontrib/websupport/storage/sqlalchemy_db.py
@@ -1,13 +1,6 @@
-# -*- coding: utf-8 -*-
 """
-    sphinxcontrib.websupport.storage.sqlalchemy_db
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-    SQLAlchemy table and mapper definitions used by the
-    :class:`sphinxcontrib.websupport.storage.sqlalchemystorage.SQLAlchemyStorage`.
-
-    :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
+SQLAlchemy table and mapper definitions used by the
+:py:class:`sphinxcontrib.websupport.storage.sqlalchemystorage.SQLAlchemyStorage`.
 """
 
 from __future__ import annotations
diff --git a/sphinxcontrib/websupport/storage/sqlalchemystorage.py b/sphinxcontrib/websupport/storage/sqlalchemystorage.py
@@ -1,13 +1,4 @@
-# -*- coding: utf-8 -*-
-"""
-    sphinxcontrib.websupport.storage.sqlalchemystorage
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-    An SQLAlchemy storage backend.
-
-    :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
+"""An SQLAlchemy storage backend."""
 
 from datetime import datetime
 
diff --git a/sphinxcontrib/websupport/templates/searchresults.html b/sphinxcontrib/websupport/templates/searchresults.html
@@ -1,12 +1,4 @@
-{#
-    searchresults.html
-    ~~~~~~~~~~~~~~~~~~
-
-    Template for the body of the search results page.
-
-    :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-#}
+{# Template for the body of the search results page. #}
 <h1 id="search-documentation">{{ _('Search') }}</h1>
 <p>
   From here you can search these documents. Enter your search
diff --git a/sphinxcontrib/websupport/utils.py b/sphinxcontrib/websupport/utils.py
@@ -1,11 +1,3 @@
-# -*- coding: utf-8 -*-
-"""
-    sphinxcontrib.websupport.utils
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-    :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
 from __future__ import annotations
 
 from typing import TYPE_CHECKING
diff --git a/sphinxcontrib/websupport/writer.py b/sphinxcontrib/websupport/writer.py
@@ -1,13 +1,4 @@
-# -*- coding: utf-8 -*-
-"""
-    sphinxcontrib.websupport.writer
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-    sphinxcontrib.websupport writer that adds comment-related annotations.
-
-    :copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
+"""websupport writer that adds comment-related annotations."""
 
 from sphinx.writers.html import HTMLTranslator
 
diff --git a/tests/conftest.py b/tests/conftest.py
@@ -1,11 +1,3 @@
-"""
-    pytest config for sphinx extensions
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-    :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
-
 from pathlib import Path
 
 import pytest
diff --git a/tests/roots/test-root/root/conf.py b/tests/roots/test-root/root/conf.py
@@ -1,5 +1,3 @@
-# -*- coding: utf-8 -*-
-
 import sys, os
 
 sys.path.append(os.path.abspath('.'))
diff --git a/tests/roots/test-searchadapters/conf.py b/tests/roots/test-searchadapters/conf.py
@@ -1,4 +1,2 @@
-# -*- coding: utf-8 -*-
-
 master_doc = 'markup'
 source_suffix = '.txt'
diff --git a/tests/test_searchadapters.py b/tests/test_searchadapters.py
@@ -1,13 +1,4 @@
-# -*- coding: utf-8 -*-
-"""
-    test_searchadapters
-    ~~~~~~~~~~~~~~~~~~~
-
-    Test the Web Support Package search adapters.
-
-    :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
+"""Test the Web Support Package search adapters."""
 
 import shutil
 from io import StringIO
diff --git a/tests/test_websupport.py b/tests/test_websupport.py
@@ -1,13 +1,4 @@
-# -*- coding: utf-8 -*-
-"""
-    test_websupport
-    ~~~~~~~~~~~~~~~
-
-    Test the Web Support Package
-
-    :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
+"""Test the Web Support Package"""
 
 from sphinxcontrib.websupport import WebSupport
 from sphinxcontrib.websupport.errors import DocumentNotFoundError, \
diff --git a/tests/util.py b/tests/util.py
@@ -1,12 +1,3 @@
-# -*- coding: utf-8 -*-
-"""
-    Sphinx test suite utilities
-    ~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-    :copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
-    :license: BSD, see LICENSE for details.
-"""
-
 import pytest
 
 
