Skip to content

Commit 7265769

Browse files
committed
docs: migrate to automatic preference listing with markdown
1 parent bf6fa78 commit 7265769

File tree

4 files changed

+34
-15
lines changed

4 files changed

+34
-15
lines changed

docs/source/conf.py

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
# Add any Sphinx extension module names here, as strings. They can be extensions
3131
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
3232
extensions = [
33+
"myst_parser",
3334
"preferences_listing",
3435
]
3536

@@ -187,6 +188,22 @@ def find_phoebus_version() -> str:
187188
htmlhelp_basename = 'Phoebusdoc'
188189

189190

191+
# -- Options for MyST's markdown -----------------------------------------------
192+
# https://myst-parser.readthedocs.io/en/latest/configuration.html
193+
194+
myst_enable_extensions = [
195+
"amsmath",
196+
"colon_fence",
197+
"deflist",
198+
"dollarmath",
199+
"fieldlist",
200+
"html_image",
201+
"replacements",
202+
"smartquotes",
203+
"strikethrough",
204+
"tasklist",
205+
]
206+
190207
# -- Options for LaTeX output --------------------------------------------------
191208

192209
latex_elements = {
Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
(preference_settings)=
2+
# Preferences Listing
3+
4+
The following preference settings are available for the various application features.
5+
To use them in your settings file, remember to prefix each setting with the package name.
6+
7+
For example,
8+
for the `drop_failed_archives` preference in the `trends.databrowser3` section
9+
(package name `org.csstudio.trends.databrowser3`) add a line like:
10+
11+
```properties
12+
org.csstudio.trends.databrowser3/drop_failed_archives=true
13+
```
14+
15+
```{prefs:listing}
16+
```

docs/source/preference_properties.rst

Lines changed: 0 additions & 15 deletions
This file was deleted.

docs/source/requirements.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
sphinx==8.2.3
22
sphinx_rtd_theme==3.0.2
3+
myst-parser==4.0.1

0 commit comments

Comments
 (0)