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
|
import contextlib
import datetime
import os
import stat
import subprocess
import tempfile
import yaml
from git import Repo
import filecmp
# Download and link swagger-ui files
if not os.path.isdir('.sphinx/deps/swagger-ui'):
Repo.clone_from('https://github.com/swagger-api/swagger-ui', '.sphinx/deps/swagger-ui', depth=1)
os.makedirs('.sphinx/_static/swagger-ui/', exist_ok=True)
if not os.path.islink('.sphinx/_static/swagger-ui/swagger-ui-bundle.js'):
os.symlink('../../deps/swagger-ui/dist/swagger-ui-bundle.js', '.sphinx/_static/swagger-ui/swagger-ui-bundle.js')
if not os.path.islink('.sphinx/_static/swagger-ui/swagger-ui-standalone-preset.js'):
os.symlink('../../deps/swagger-ui/dist/swagger-ui-standalone-preset.js', '.sphinx/_static/swagger-ui/swagger-ui-standalone-preset.js')
if not os.path.islink('.sphinx/_static/swagger-ui/swagger-ui.css'):
os.symlink('../../deps/swagger-ui/dist/swagger-ui.css', '.sphinx/_static/swagger-ui/swagger-ui.css')
### MAN PAGES ###
# Find the path to the incus binary
path = str(subprocess.check_output(['go', 'env', 'GOPATH'], encoding="utf-8").strip())
incus = os.path.join(path, 'bin', 'incus')
if os.path.isfile(incus):
print("Using " + incus + " to generate man pages.")
else:
print("Cannot find incus in " + incus)
exit(2)
# Generate man pages content
os.makedirs('.sphinx/deps/manpages', exist_ok=True)
subprocess.run([incus, 'manpage', '.sphinx/deps/manpages/', '--format=md', '--all'],
check=True)
# Preprocess man pages content
for page in [x for x in os.listdir('.sphinx/deps/manpages')
if os.path.isfile(os.path.join('.sphinx/deps/manpages/', x))]:
# replace underscores with slashes to create a directory structure
pagepath = page.replace('_', '/')
# for each generated page, add an anchor, fix the title, and adjust the
# heading levels
with open(os.path.join('.sphinx/deps/manpages/', page), 'r') as mdfile:
content = mdfile.readlines()
os.makedirs(os.path.dirname(os.path.join('.sphinx/deps/manpages/', pagepath)),
exist_ok=True)
with open(os.path.join('.sphinx/deps/manpages/', pagepath), 'w') as mdfile:
mdfile.write('(' + page + ')=\n')
line_block = False
for line in content:
if line.startswith('###### Auto generated'):
continue
elif line.startswith('### Synopsis'):
mdfile.write('## Synopsis\n')
mdfile.write('```{line-block}\n')
line_block = True
elif line.startswith('## '):
mdfile.write('# `' + line[3:].rstrip() + '`\n')
elif line.startswith('```'):
if line_block:
mdfile.write('```\n')
line_block = False
mdfile.write(line)
elif line.startswith('##'):
if line_block:
mdfile.write('```\n')
line_block = False
mdfile.write(line[1:])
else:
mdfile.write(line)
# remove the input page (unless the file path doesn't change)
if '_' in page:
os.remove(os.path.join('.sphinx/deps/manpages/', page))
# Complete and copy man pages content
for folder, subfolders, files in os.walk('.sphinx/deps/manpages'):
# for each subfolder, add toctrees to the parent page that
# include the subpages
for subfolder in subfolders:
with open(os.path.join(folder, subfolder + '.md'), 'a') as parent:
parent.write('```{toctree}\n:titlesonly:\n:glob:\n:hidden:\n\n' +
subfolder + '/*\n```\n')
# for each file, if the content is different to what has been generated
# before, copy the file to the reference/manpages folder
# (copying all would mess up the incremental build)
for f in files:
sourcefile = os.path.join(folder, f)
targetfile = os.path.join('reference/manpages/',
os.path.relpath(folder,
'.sphinx/deps/manpages'),
f)
if (not os.path.isfile(targetfile) or
not filecmp.cmp(sourcefile, targetfile, shallow=False)):
os.makedirs(os.path.dirname(targetfile), exist_ok=True)
os.system('cp ' + sourcefile + ' ' + targetfile)
### End MAN PAGES ###
# Project config.
project = "Incus"
author = "Incus contributors"
copyright = "2014-%s %s" % (datetime.date.today().year, author)
with open("../internal/version/flex.go") as fd:
version = fd.read().split("\n")[-2].split()[-1].strip("\"")
# Extensions.
extensions = [
"config-options",
"custom-rst-roles",
"myst_parser",
"notfound.extension",
"related-links",
"sphinxcontrib.jquery",
"sphinx_copybutton",
"sphinx_design",
"sphinx.ext.intersphinx",
"sphinxext.opengraph",
"sphinx_remove_toctrees",
"sphinx_reredirects",
"sphinx_tabs.tabs",
"terminal-output",
"youtube-links"
]
myst_enable_extensions = [
"deflist",
"linkify",
"substitution"
]
myst_linkify_fuzzy_links = False
myst_heading_anchors = 7
if os.path.exists("./substitutions.yaml"):
with open("./substitutions.yaml", "r") as fd:
myst_substitutions = yaml.safe_load(fd.read())
if os.path.exists("./related_topics.yaml"):
with open("./related_topics.yaml", "r") as fd:
myst_substitutions.update(yaml.safe_load(fd.read()))
intersphinx_mapping = {
'cloud-init': ('https://cloudinit.readthedocs.io/en/latest/', None)
}
if ("LOCAL_SPHINX_BUILD" in os.environ) and (os.environ["LOCAL_SPHINX_BUILD"] == "True"):
swagger_url_scheme = "/api/#{{path}}"
else:
swagger_url_scheme = "/incus/docs/main/api/#{{path}}"
myst_url_schemes = {
"http": None,
"https": None,
"swagger": swagger_url_scheme,
}
remove_from_toctrees = ["reference/manpages/incus/*.md"]
# Setup theme.
html_theme = "furo"
html_show_sphinx = False
html_last_updated_fmt = ""
html_favicon = ".sphinx/_static/favicon.ico"
html_static_path = ['.sphinx/_static']
html_css_files = ['custom.css', 'furo_colors.css']
html_extra_path = ['.sphinx/_extra']
html_theme_options = {
"sidebar_hide_name": True,
}
html_context = {
"github_url": "https://github.com/lxc/incus",
"github_version": "main",
"github_folder": "/doc/",
"github_filetype": "md",
"discourse_prefix": {
"lxc": "https://discuss.linuxcontainers.org/t/"}
}
source_suffix = ".md"
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path.
exclude_patterns = ['html', 'README.md', '.sphinx', 'config_options_cheat_sheet.md']
# Open Graph configuration
ogp_site_url = "https://linuxcontainers.org/incus/docs/main/"
ogp_site_name = "Incus documentation"
ogp_image = "https://linuxcontainers.org/static/img/containers.png"
# Links to ignore when checking links
linkcheck_ignore = [
'https://127.0.0.1:8443/1.0',
'https://web.libera.chat/#lxc',
'http://localhost:8001',
'https://www.schlachter.tech/solutions/pongo2-template-engine/',
r'/incus/docs/main/api/.*',
r'/api/.*'
]
linkcheck_exclude_documents = [r'.*/manpages/.*']
linkcheck_anchors_ignore_for_url = [
r'https://github\.com/.*'
]
# Setup redirects (https://documatt.gitlab.io/sphinx-reredirects/usage.html)
redirects = {
"howto/instances_snapshots/index": "../instances_backup/",
}
|
