__init__.py

Summary

Lines:

0 of 0 covered (100.0%)

Coverage:

100.0%

Directory:

Resources

Source

pyTooling/Sphinx/Resources/__init__.pycoveredpartialuncoveredexcludednot executable
1# ==================================================================================================================== #
2#             _____           _ _               ____        _     _                                                    #
3#  _ __  _   |_   _|__   ___ | (_)_ __   __ _  / ___| _ __ | |__ (_)_ __ __  __                                        #
4# | '_ \| | | || |/ _ \ / _ \| | | '_ \ / _` | \___ \| '_ \| '_ \| | '_ \\ \/ /                                        #
5# | |_) | |_| || | (_) | (_) | | | | | | (_| |_ ___) | |_) | | | | | | | |>  <                                         #
6# | .__/ \__, ||_|\___/ \___/|_|_|_| |_|\__, (_)____/| .__/|_| |_|_|_| |_/_/\_\                                        #
7# |_|    |___/                          |___/        |_|                                                               #
8# ==================================================================================================================== #
9# Authors:                                                                                                             #
10#   Patrick Lehmann                                                                                                    #
11#                                                                                                                      #
12# License:                                                                                                             #
13# ==================================================================================================================== #
14# Copyright 2026-2026 Patrick Lehmann - Bötzingen, Germany                                                             #
15#                                                                                                                      #
16# Licensed under the Apache License, Version 2.0 (the "License");                                                      #
17# you may not use this file except in compliance with the License.                                                     #
18# You may obtain a copy of the License at                                                                              #
19#                                                                                                                      #
20#   http://www.apache.org/licenses/LICENSE-2.0                                                                         #
21#                                                                                                                      #
22# Unless required by applicable law or agreed to in writing, software                                                  #
23# distributed under the License is distributed on an "AS IS" BASIS,                                                    #
24# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.                                             #
25# See the License for the specific language governing permissions and                                                  #
26# limitations under the License.                                                                                       #
27#                                                                                                                      #
28# SPDX-License-Identifier: Apache-2.0                                                                                  #
29# ==================================================================================================================== #
30#
31"""
32Resources shipped for :mod:`pyTooling.Sphinx`.
33
34.. rubric:: Stylesheets
35
36* :file:`pyTooling.css` - the styles the roles in :mod:`~pyTooling.Sphinx.Roles`, the dependency tables, the
37  trees, the Unicode tables, the report tables of domain ``report`` and the icons behind external links need.
38
39.. rubric:: Scripts
40
41* :file:`pyTooling.js` - copies a text into the clipboard, when a reader clicks a copy button of a Unicode table.
42
43.. rubric:: LaTeX Packages
44
45* :file:`pyTooling.Sphinx.sty` - the commands LaTeX writes for the style roles ``:strike:`` and ``:underline:``, which
46  draw their lines with package ``ulem``.
47
48.. rubric:: Data Files
49
50* :file:`GitHubEmoji.txt` - GitHub's emoji, their code points and shortcodes, which
51  :class:`~pyTooling.Sphinx.GitHubMarkdown.GitHubMarkdown` converts. Generated from github/gemoji (MIT license,
52  Copyright (c) 2019 GitHub, Inc.); its header names the version and holds the license text.
53"""