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
|
#
# This file is part of m.css.
#
# Copyright © 2017, 2018, 2019, 2020, 2021, 2022, 2023
# Vladimír Vondruš <mosra@centrum.cz>
#
# Permission is hereby granted, free of charge, to any person obtaining a
# copy of this software and associated documentation files (the "Software"),
# to deal in the Software without restriction, including without limitation
# the rights to use, copy, modify, merge, publish, distribute, sublicense,
# and/or sell copies of the Software, and to permit persons to whom the
# Software is furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included
# in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
# THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
# FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
# DEALINGS IN THE SOFTWARE.
#
import os
import unittest
from typing import List
from . import BaseInspectTestCase
from python import EntryType, default_id_formatter
from _search import searchdata_format_version
def custom_url_formatter(type: EntryType, path: List[str]) -> str:
if type == EntryType.CLASS:
filename = 'c.' + '.'.join(path) + '.html'
elif type == EntryType.MODULE:
filename = 'm.' + '.'.join(path) + '.html'
elif type == EntryType.PAGE:
filename = 'p.' + '.'.join(path) + '.html'
elif type == EntryType.SPECIAL:
filename = 's.' + '.'.join(path) + '.html'
elif type == EntryType.STATIC:
assert len(path) == 1
url = os.path.basename(path[0])
# Encode version information into the search driver
if url == 'search.js':
url = 'search-v{}.js'.format(searchdata_format_version)
# Everything except the search data (which don't exist yet) should be
# absolute
if url != 'absolutesearchdata-v{}.bin'.format(searchdata_format_version):
assert os.path.isabs(path[0]) and os.path.exists(path[0]), path[0]
filename = 't.' + url
else: assert False
return filename, filename + "#this-is-an-url"
def custom_id_formatter(type: EntryType, path: List[str]) -> str:
if type == EntryType.FUNCTION:
return 'f-' + '-'.join(path)
if type == EntryType.OVERLOADED_FUNCTION:
# Reuse the original hasher so we can test its behavior
return 'o-' + default_id_formatter(type, path)
if type == EntryType.PROPERTY:
return 'p-' + '-'.join(path)
if type == EntryType.ENUM:
return 'e-' + '-'.join(path)
if type == EntryType.ENUM_VALUE:
return 'v-' + '-'.join(path)
if type == EntryType.DATA:
return 'd-' + '-'.join(path)
assert False
class LinkFormatting(BaseInspectTestCase):
def test(self):
self.run_python({
'INPUT_PAGES': ['page.rst'],
'URL_FORMATTER': custom_url_formatter,
'ID_FORMATTER': custom_id_formatter,
'PLUGINS': ['m.images'],
'LINKS_NAVBAR1': [
('Pages', 'pages', []),
('Modules', 'modules', []),
('Classes', 'classes', [])],
'LINKS_NAVBAR2': [('A page', 'page', []),
('A module', 'link_formatting', []),
('The class', ['link_formatting', 'Class'], [])],
'FAVICON': 'favicon-light.png',
'SEARCH_DISABLED': False, # to test search link formatting, too
'SEARCH_HELP': 'blub?',
'SEARCH_DOWNLOAD_BINARY': 'absolutesearchdata-v{}.bin'.format(searchdata_format_version),
'PYBIND11_COMPATIBILITY': True
})
self.assertEqual(*self.actual_expected_contents('m.link_formatting.html'))
self.assertEqual(*self.actual_expected_contents('m.link_formatting.sub.html'))
self.assertEqual(*self.actual_expected_contents('c.link_formatting.Class.html'))
self.assertEqual(*self.actual_expected_contents('c.link_formatting.Class.Sub.html'))
self.assertEqual(*self.actual_expected_contents('p.page.html'))
self.assertEqual(*self.actual_expected_contents('s.classes.html'))
self.assertEqual(*self.actual_expected_contents('s.modules.html'))
self.assertEqual(*self.actual_expected_contents('s.pages.html'))
# There's nothing inside s.index.html that wouldn't be already covered
# by others
self.assertTrue(os.path.exists(os.path.join(self.path, 'output/s.index.html')))
# Verify pybind11 overloaded function hashing as well
self.assertEqual(*self.actual_expected_contents('m.link_formatting.pybind.html'))
self.assertEqual(*self.actual_expected_contents('c.link_formatting.pybind.Foo.html'))
# Static data
self.assertTrue(os.path.exists(os.path.join(self.path, 'output/t.favicon-light.png')))
self.assertTrue(os.path.exists(os.path.join(self.path, 'output/t.m-dark+documentation.compiled.css')))
self.assertTrue(os.path.exists(os.path.join(self.path, 'output/t.search-v{}.js'.format(searchdata_format_version))))
self.assertTrue(os.path.exists(os.path.join(self.path, 'output/t.absolutesearchdata-v{}.bin'.format(searchdata_format_version))))
self.assertTrue(os.path.exists(os.path.join(self.path, 'output/t.tiny.png')))
|
