Skip to content

Commit b6925aa

Browse files
AA-TurnerAA-Turner
committed
Remove module titles in docstrings
1 parent 6f542cc commit b6925aa

21 files changed

+17
-188
lines changed

‎sphinxcontrib/websupport/__init__.py

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,4 @@
1-
# -*- coding: utf-8 -*-
2-
"""
3-
sphinxcontrib.websupport
4-
~~~~~~~~~~~~~~~~~~~~~~~~
5-
6-
A Python API to easily integrate Sphinx documentation into Web
7-
applications.
8-
9-
:copyright: Copyright 2007-2018 by the Sphinx team, see README.
10-
:license: BSD, see LICENSE for details.
11-
"""
1+
"""A Python API to easily integrate Sphinx documentation into Web applications."""
122
from os import path
133

144

‎sphinxcontrib/websupport/builder.py

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,4 @@
1-
# -*- coding: utf-8 -*-
2-
"""
3-
sphinx.builders.websupport
4-
~~~~~~~~~~~~~~~~~~~~~~~~~~
5-
6-
Builder for the web support package.
7-
8-
:copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
9-
:license: BSD, see LICENSE for details.
10-
"""
1+
"""Builder for the web support extension."""
112

123
from __future__ import annotations
134

‎sphinxcontrib/websupport/core.py

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,4 @@
1-
# -*- coding: utf-8 -*-
2-
"""
3-
sphinxcontrib.websupport.core
4-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5-
6-
Base Module for web support functions.
7-
8-
:copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
9-
:license: BSD, see LICENSE for details.
10-
"""
1+
"""Base Module for web support functions."""
112

123
from __future__ import annotations
134

‎sphinxcontrib/websupport/errors.py

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,4 @@
1-
# -*- coding: utf-8 -*-
2-
"""
3-
sphinxcontrib.websupport.errors
4-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5-
6-
Contains Error classes for the web support package.
7-
8-
:copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
9-
:license: BSD, see LICENSE for details.
10-
"""
1+
"""Contains Error classes for the web support package."""
112

123

134
class DocumentNotFoundError(Exception):

‎sphinxcontrib/websupport/search/__init__.py

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,4 @@
1-
# -*- coding: utf-8 -*-
2-
"""
3-
sphinxcontrib.websupport.search
4-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5-
6-
Server side search support for the web support package.
7-
8-
:copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
9-
:license: BSD, see LICENSE for details.
10-
"""
1+
"""Server side search support for the web support package."""
112

123
import re
134

‎sphinxcontrib/websupport/search/nullsearch.py

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,4 @@
1-
# -*- coding: utf-8 -*-
2-
"""
3-
sphinxcontrib.websupport.search.nullsearch
4-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5-
6-
The default search adapter, does nothing.
7-
8-
:copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
9-
:license: BSD, see LICENSE for details.
10-
"""
1+
"""The default search adapter, does nothing."""
112

123
from sphinxcontrib.websupport.search import BaseSearch
134
from sphinxcontrib.websupport.errors import NullSearchException

‎sphinxcontrib/websupport/search/whooshsearch.py

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,4 @@
1-
# -*- coding: utf-8 -*-
2-
"""
3-
sphinxcontrib.websupport.search.whooshsearch
4-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5-
6-
Whoosh search adapter.
7-
8-
:copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
9-
:license: BSD, see LICENSE for details.
10-
"""
1+
"""Whoosh search adapter."""
112

123
from whoosh import index
134
from whoosh.fields import Schema, ID, TEXT

‎sphinxcontrib/websupport/search/xapiansearch.py

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,4 @@
1-
# -*- coding: utf-8 -*-
2-
"""
3-
sphinxcontrib.websupport.search.xapiansearch
4-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5-
6-
Xapian search adapter.
7-
8-
:copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
9-
:license: BSD, see LICENSE for details.
10-
"""
1+
"""Xapian search adapter."""
112

123
import xapian
134

‎sphinxcontrib/websupport/storage/__init__.py

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,4 @@
1-
# -*- coding: utf-8 -*-
2-
"""
3-
sphinxcontrib.websupport.storage
4-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5-
6-
Storage for the websupport package.
7-
8-
:copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
9-
:license: BSD, see LICENSE for details.
10-
"""
1+
"""Storage for the websupport package."""
112

123

134
class StorageBackend(object):

‎sphinxcontrib/websupport/storage/differ.py

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,4 @@
1-
# -*- coding: utf-8 -*-
2-
"""
3-
sphinxcontrib.websupport.storage.differ
4-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5-
6-
A differ for creating an HTML representations of proposal diffs
7-
8-
:copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
9-
:license: BSD, see LICENSE for details.
10-
"""
1+
"""A differ for creating an HTML representations of proposal diffs."""
112

123
import html
134
import re

‎sphinxcontrib/websupport/storage/sqlalchemy_db.py

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
1-
# -*- coding: utf-8 -*-
21
"""
3-
sphinxcontrib.websupport.storage.sqlalchemy_db
4-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5-
6-
SQLAlchemy table and mapper definitions used by the
7-
:class:`sphinxcontrib.websupport.storage.sqlalchemystorage.SQLAlchemyStorage`.
8-
9-
:copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
10-
:license: BSD, see LICENSE for details.
2+
SQLAlchemy table and mapper definitions used by the
3+
:py:class:`sphinxcontrib.websupport.storage.sqlalchemystorage.SQLAlchemyStorage`.
114
"""
125

136
from __future__ import annotations

‎sphinxcontrib/websupport/storage/sqlalchemystorage.py

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,4 @@
1-
# -*- coding: utf-8 -*-
2-
"""
3-
sphinxcontrib.websupport.storage.sqlalchemystorage
4-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5-
6-
An SQLAlchemy storage backend.
7-
8-
:copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
9-
:license: BSD, see LICENSE for details.
10-
"""
1+
"""An SQLAlchemy storage backend."""
112

123
from datetime import datetime
134

‎sphinxcontrib/websupport/templates/searchresults.html

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,4 @@
1-
{#
2-
searchresults.html
3-
~~~~~~~~~~~~~~~~~~
4-
5-
Template for the body of the search results page.
6-
7-
:copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS.
8-
:license: BSD, see LICENSE for details.
9-
#}
1+
{# Template for the body of the search results page. #}
102
<h1 id="search-documentation">{{ _('Search') }}</h1>
113
<p>
124
From here you can search these documents. Enter your search

‎sphinxcontrib/websupport/utils.py

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,3 @@
1-
# -*- coding: utf-8 -*-
2-
"""
3-
sphinxcontrib.websupport.utils
4-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5-
6-
:copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
7-
:license: BSD, see LICENSE for details.
8-
"""
91
from __future__ import annotations
102

113
from typing import TYPE_CHECKING

‎sphinxcontrib/websupport/writer.py

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,4 @@
1-
# -*- coding: utf-8 -*-
2-
"""
3-
sphinxcontrib.websupport.writer
4-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
5-
6-
sphinxcontrib.websupport writer that adds comment-related annotations.
7-
8-
:copyright: Copyright 2007-2016 by the Sphinx team, see AUTHORS.
9-
:license: BSD, see LICENSE for details.
10-
"""
1+
"""websupport writer that adds comment-related annotations."""
112

123
from sphinx.writers.html import HTMLTranslator
134

‎tests/conftest.py

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,3 @@
1-
"""
2-
pytest config for sphinx extensions
3-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
4-
5-
:copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS.
6-
:license: BSD, see LICENSE for details.
7-
"""
8-
91
from pathlib import Path
102

113
import pytest

‎tests/roots/test-root/root/conf.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
# -*- coding: utf-8 -*-
2-
31
import sys, os
42

53
sys.path.append(os.path.abspath('.'))

‎tests/roots/test-searchadapters/conf.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,2 @@
1-
# -*- coding: utf-8 -*-
2-
31
master_doc = 'markup'
42
source_suffix = '.txt'

‎tests/test_searchadapters.py

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,4 @@
1-
# -*- coding: utf-8 -*-
2-
"""
3-
test_searchadapters
4-
~~~~~~~~~~~~~~~~~~~
5-
6-
Test the Web Support Package search adapters.
7-
8-
:copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
9-
:license: BSD, see LICENSE for details.
10-
"""
1+
"""Test the Web Support Package search adapters."""
112

123
import shutil
134
from io import StringIO

‎tests/test_websupport.py

Lines changed: 1 addition & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,4 @@
1-
# -*- coding: utf-8 -*-
2-
"""
3-
test_websupport
4-
~~~~~~~~~~~~~~~
5-
6-
Test the Web Support Package
7-
8-
:copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
9-
:license: BSD, see LICENSE for details.
10-
"""
1+
"""Test the Web Support Package"""
112

123
from sphinxcontrib.websupport import WebSupport
134
from sphinxcontrib.websupport.errors import DocumentNotFoundError, \

‎tests/util.py

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,3 @@
1-
# -*- coding: utf-8 -*-
2-
"""
3-
Sphinx test suite utilities
4-
~~~~~~~~~~~~~~~~~~~~~~~~~~~
5-
6-
:copyright: Copyright 2007-2018 by the Sphinx team, see AUTHORS.
7-
:license: BSD, see LICENSE for details.
8-
"""
9-
101
import pytest
112

123

0 commit comments

Comments
 (0)