File: 0001-remove-links-from-doc.patch

package info (click to toggle)
python-beartype 0.21.0-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 8,468 kB
  • sloc: python: 77,936; sh: 299; makefile: 30
file content (277 lines) | stat: -rw-r--r-- 11,784 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
From: Ananthu C V <weepingclown@disroot.org>
Date: Fri, 26 Jan 2024 12:04:35 +0530
Subject: remove-links-from-doc
Forwarded: not-needed

---
 doc/src/_links.rst   |  6 ------
 doc/src/api_claw.rst | 17 ----------------
 doc/src/conf.py      | 11 ----------
 doc/src/faq.rst      |  6 ------
 doc/src/index.rst    | 57 ++--------------------------------------------------
 doc/src/install.rst  | 44 ----------------------------------------
 6 files changed, 2 insertions(+), 139 deletions(-)

--- a/doc/src/_links.rst
+++ b/doc/src/_links.rst
@@ -9,8 +9,2 @@
 
-.. # ------------------( IMAGES ~ badge                      )------------------
-.. |bear-ified| image:: https://raw.githubusercontent.com/beartype/beartype-assets/main/badge/bear-ified.svg
-   :align: top
-   :target: https://beartype.readthedocs.io
-   :alt: bear-ified
-
 .. # ------------------( IMAGES ~ downstream                 )------------------
--- a/doc/src/api_claw.rst
+++ b/doc/src/api_claw.rst
@@ -85,6 +85,2 @@
 
-.. image:: https://user-images.githubusercontent.com/217028/272775190-8996c4a2-b320-4ca1-ba83-5c4dd36e6165.png
-   :width: 300
-   :alt: mutant brain baby
-
 :superscript:`May Neo-Tokyo have mercy on your codebase's soul.`
@@ -172,5 +168,2 @@
 
-.. image:: https://user-images.githubusercontent.com/217028/272775040-9bf81c0b-3994-4420-a1d5-ac5835f0a0b2.png
-   :alt: looks kinda bad
-
 :superscript:`This is what happens when we don't beartype_this_package().`
@@ -286,4 +279,2 @@
    .. versionadded:: 0.15.0
-   .. image:: https://user-images.githubusercontent.com/217028/272775398-761b9f11-95c2-4410-ad56-fd1ebe99bf04.png
-      :alt: fierce determined face
 
@@ -379,4 +370,2 @@
    .. versionadded:: 0.15.0
-   .. image:: https://user-images.githubusercontent.com/217028/272775461-e5f62d59-9fe9-49e8-9904-47a1326d8695.png
-      :alt: wizened psychic baby lady
 
@@ -456,5 +445,2 @@
    .. versionadded:: 0.15.0
-   .. image:: https://user-images.githubusercontent.com/217028/272775529-42b85874-56b7-40b4-b9d8-19b603df1657.png
-      :width: 256
-      :alt: it's the end of the road as we know it, and i feel fine
 
@@ -526,5 +512,2 @@
    .. versionadded:: 0.15.0
-   .. image:: https://github.com/beartype/beartype-assets/assets/217028/cf43dca7-1852-4fec-bcbc-6d4aeca23230
-      :width: 400
-      :alt: quiet, safe life
 
--- a/doc/src/conf.py
+++ b/doc/src/conf.py
@@ -262,62 +262,2 @@
 
-# ....................{ EXTENSIONS ~ optional : theme      }....................
-# Fully-qualified name of the package providing the third-party Sphinx extension
-# defining the custom HTML theme preferred by this documentation, globally
-# substituting hyphens with underscores to produce a valid Python identifier.
-_SPHINX_THEME_MODULE_NAME = SPHINX_THEME_NAME.replace('-', '_')
-
-# If this package is importable under the active Python interpreter, enable this
-# theme for improved HTML rendering.
-if is_module(_SPHINX_THEME_MODULE_NAME):
-    # Set the HTML theme to this package.
-    #
-    # Note that we do *NOT* do this, which non-theme extensions require:
-    #     # Register the fully-qualified name of this extension.
-    #     extensions.append(SPHINX_THEME_NAME)
-    #
-    # Why? Because doing so induces this exception from modern themes like Furo
-    # and PyData:
-    #     Extension error (furo):
-    #     Handler <function _builder_inited at 0x7f9be7bf2040> for event
-    #     'builder-inited' threw an exception (exception: Did you list 'furo' in
-    #     the `extensions` in conf.py? If so, please remove it. Furo does not
-    #     work with non-HTML builders and specifying it as an `html_theme` is
-    #     sufficient.)
-    html_theme = _SPHINX_THEME_MODULE_NAME
-
-    #FIXME: *KLUDGE WARNING.* Revert this to just the following one-liner *AFTER*
-    #successfully upgrading to the most recent stable release of the PyData theme:
-    #    # Add any paths that contain templates here, relative to this directory.
-    #    templates_path = ['_templates']
-
-    # String version of the currently installed version of this theme.
-    _SPHINX_THEME_MODULE_VERSION = import_module_attr(
-        f'{_SPHINX_THEME_MODULE_NAME}.__version__')
-
-    # If this version is that of a version known to supply the requisite Jinja2
-    # functionality required by project-specific templates...
-    if _SPHINX_THEME_MODULE_VERSION == '0.7.2':
-        # Add any paths that contain templates here, relative to this directory.
-        templates_path = ['_templates']
-    # Else, silently ignore these templates. Attempting to use this templates
-    # under any other version of this theme is likely to raise exceptions: e.g.,
-    #     Theme error:
-    #     An error happened in rendering the page api.
-    #     Reason: UndefinedError("'generate_nav_html' is undefined")
-# Else, this theme is unavailable. In this case, fallback to Sphinx's default
-# HTML theme *AND*...
-else:
-    #FIXME: Convert this back into a warning by calling warn() *AFTER* deciding
-    #how to do so safely. The core issue is that we convert warnings into
-    #failures during testing; ergo, we need to install the Python package
-    #providing this theme during testing. We can't be bothered at the moment.
-
-    # Emit a non-fatal warning informing end users of this fallback.
-    print(
-        (
-            f'WARNING: Optional Sphinx extension "{SPHINX_THEME_NAME}" '
-            f'not found; falling back to default Sphinx HTML theme.'
-        ),
-    )
-
 # ....................{ EXTENSIONS ~ optional : non-theme  }....................
@@ -475,8 +415,2 @@
 #   https://gist.github.com/bskinn/0e164963428d4b51017cebdb6cda5209
-intersphinx_mapping = {
-    'python': ('https://docs.python.org/3', None),
-    'numpy':  ('https://numpy.org/doc/stable', None),
-    'pandas': ('https://pandas.pydata.org/docs', None),
-    'scipy':  ('https://docs.scipy.org/doc/scipy', None),
-}
 
@@ -523,7 +457,2 @@
 
-# ....................{ BUILD ~ html                       }....................
-# Relative filename or URL of a small image (i.e., no wider than 200px) to be
-# rendered in the upper left-hand corner of the sidebar for this theme.
-html_logo = 'https://raw.githubusercontent.com/beartype/beartype-assets/main/badge/bear-ified.svg'
-
 # Add any paths that contain custom static files (such as style sheets) here,
--- a/doc/src/faq.rst
+++ b/doc/src/faq.rst
@@ -1127,4 +1127,2 @@
 
-|VSCode-Pylance-type-checking-setting|
-
 :sup:`Pretend that reads "off" rather than "strict". Pretend we took
@@ -1142,6 +1140,2 @@
 
-.. # ------------------( IMAGES ~ screenshot                 )------------------
-.. |VSCode-Pylance-type-checking-setting| image:: https://user-images.githubusercontent.com/217028/164616311-c4a24889-0c53-4726-9051-29be7263ee9b.png
-   :alt: Disabling pyright-based VSCode Pylance type-checking
-
 ...under [insert-IDE-name-here]?
--- a/doc/src/index.rst
+++ b/doc/src/index.rst
@@ -20,27 +20,4 @@
 
-.. # ------------------( TODO                                )------------------
-.. #FIXME: Replace and/or supplement badges shown below with third-party badges
-.. #published by "https://shields.io"; the look-and-feel of shields.io badges is
-.. #the flat design favoured by modern apps and thus ostensibly superior to
-.. #anything else I've seen. Relevant HTML that we'll want to translate into
-.. #corresponding reST resembles:
-.. #    <a href="https://github.com/beartype/beartype/stargazers">
-.. #    <img src="https://img.shields.io/github/stars/beartype/beartype?style=for-the-badge" alt="@beartype stars"/>
-.. #    </a>
-.. #    <a href="https://github.com/beartype/beartype/fork">
-.. #    <img src="https://img.shields.io/github/forks/beartype/beartype?style=for-the-badge" alt="@beartype forks"/>
-.. #    </a>
-.. #    </a>
-.. #    <a href="https://github.com/beartype/beartype/releases">
-.. #    <img src="https://img.shields.io/github/release/beartype/beartype?&label=Latest&style=for-the-badge"/>
-.. #
-.. #See also this exhaustive list of all GitHub-specific shield.io badges:
-.. #    https://shields.io/category/activity
-
 .. # ------------------( MAIN                                )------------------
 
-|beartype-banner|
-
-|codecov-badge| |ci-badge| |rtd-badge|
-
 **Beartype** is an `open-source <beartype license_>`__ :ref:`pure-Python
@@ -296,35 +273,5 @@
 Beartype is the work product of volunteer enthusiasm, excess caffeine, and
-sleepless Wednesday evenings. These brave GitHubbers hurtled `the pull request
-(PR) gauntlet <beartype pulls_>`__ so that you wouldn't have to:
-
-|beartype-contributors|
+sleepless Wednesday evenings. The brave GitHubbers hurtled `the pull request
+(PR) gauntlet <beartype pulls_>`__ so that you wouldn't have to.
 
 It's a heavy weight they bear. Applaud them as they buckle under the load!
-
-#######
-History
-#######
-
-|beartype-stars|
-
-.. # ------------------( IMAGES                              )------------------
-.. |beartype-banner| image:: https://raw.githubusercontent.com/beartype/beartype-assets/main/banner/logo.png
-   :target: https://github.com/beartype/beartype
-   :alt: beartype —[ the bare-metal type-checker ]—
-.. |beartype-contributors| image:: https://contrib.rocks/image?repo=beartype/beartype
-   :target: https://github.com/beartype/beartype/graphs/contributors
-   :alt: Beartype contributors
-.. |beartype-stars| image:: https://star-history.com/#beartype/beartype&Date
-   :target: https://github.com/beartype/beartype/stargazers
-   :alt: Beartype stargazers
-
-.. # ------------------( IMAGES ~ badge                      )------------------
-.. |ci-badge| image:: https://github.com/beartype/beartype/workflows/test/badge.svg
-   :target: https://github.com/beartype/beartype/actions?workflow=test
-   :alt: beartype continuous integration (CI) status
-.. |codecov-badge| image:: https://codecov.io/gh/beartype/beartype/branch/main/graph/badge.svg?token=E6F4YSY9ZQ
-   :target: https://codecov.io/gh/beartype/beartype
-   :alt: beartype test coverage status
-.. |rtd-badge| image:: https://readthedocs.org/projects/beartype/badge/?version=latest
-   :target: https://beartype.readthedocs.io/en/latest/?badge=latest
-   :alt: beartype Read The Docs (RTD) status
--- a/doc/src/install.rst
+++ b/doc/src/install.rst
@@ -44,6 +44,2 @@
 
-`Commemorate this moment in time <Badge_>`__ with |bear-ified|, our
-over\ *bear*\ ing project shield. What says quality like `a bear on a badge
-<Badge_>`__, amirite?
-
 .. # ------------------( TABLES OF CONTENTS                  )------------------
@@ -115,41 +111 @@
 be simpler?* O_o
-
-*****
-Badge
-*****
-
-If you're feeling the quality assurance and want to celebrate, consider
-signaling that you're now publicly *bear-*\ ified:
-
-  YummySoft is now |bear-ified|!
-
-All this magic and possibly more can be yours with:
-
-* **Markdown**:
-
-  .. code-block:: md
-
-     YummySoft is now [![bear-ified](https://raw.githubusercontent.com/beartype/beartype-assets/main/badge/bear-ified.svg)](https://beartype.readthedocs.io)!
-
-* **reStructuredText**:
-
-  .. code-block:: rst
-
-     YummySoft is now |bear-ified|!
-
-     .. # See https://docutils.sourceforge.io/docs/ref/rst/directives.html#image
-     .. |bear-ified| image:: https://raw.githubusercontent.com/beartype/beartype-assets/main/badge/bear-ified.svg
-        :align: top
-        :target: https://beartype.readthedocs.io
-        :alt: bear-ified
-
-* **Raw HTML**:
-
-  .. code-block:: html
-
-     YummySoft is now <a href="https://beartype.readthedocs.io"><img
-       src="https://raw.githubusercontent.com/beartype/beartype-assets/main/badge/bear-ified.svg"
-       alt="bear-ified"
-       style="vertical-align: middle;"></a>!
-
-Let a soothing pastel bear give your users the reassuring **OK** sign.