esbonio
esbonio copied to clipboard
Release and development version both do not display preview
Expected behavior
Expect that clicking the preview button will display a preview
Actual behavior
The release version does nothing and there is nothing in the log window. I will try to provide the extended log. One of our team was able to get it working by switching to a different version of python (3 showed up in their list). I tried using the development version and could get a a window to popup saying it could not find any files to display, but something I have done has made that go away. Under the development version, I see the log below using the extended logging
Log output
[client] Python extension is available
[client] Activating python extension
[client] Running Command: C:\Users\Fred\AppData\Local\Programs\Python\Python310\python.exe -c import sys ; print("{0.major}.{0.minor}.{0.micro}".format(sys.version_info))
[client] Python version: '3.10.11'
[client] Running Command: C:\Users\Fred\AppData\Local\Programs\Python\Python310\python.exe -m esbonio --version
[client] Server version '0.16.4'
[client] Server version '0.16.4'
[client] Update checks are disabled
[client] Server start command: C:\Users\Fred\AppData\Local\Programs\Python\Python310\python.exe -m esbonio
[client] LanguageClientOptions: {
"documentSelector": [
{
"scheme": "file",
"language": "restructuredtext"
},
{
"scheme": "file",
"language": "python"
}
],
"initializationOptions": {
"sphinx": {
"buildDir": "\\C:\\Users\\Fred\\AppData\\Roaming\\Code\\User\\workspaceStorage\\6bc42b328c8545c5b5951f9afee3d749\\swyddfa.esbonio\\sphinx",
"builderName": "html",
"confDir": null,
"configOverrides": {},
"doctreeDir": null,
"forceFullBuild": false,
"keepGoing": false,
"makeMode": true,
"numJobs": 1,
"quiet": false,
"silent": false,
"srcDir": null,
"tags": [],
"verbosity": 0,
"warningIsError": false
},
"server": {
"logLevel": "debug",
"logFilter": [],
"hideSphinxOutput": false,
"showDeprecationWarnings": false,
"completion": {
"preferredInsertBehavior": "replace"
}
}
},
"outputChannel": {
"name": "Esbonio"
}
}
[client] Starting Language Server
[esbonio.lsp] Loaded extension 'esbonio.lsp.directives'
[esbonio.lsp] Loaded extension 'esbonio.lsp.roles'
[esbonio.lsp] Loaded extension 'esbonio.lsp.rst.directives'
[esbonio.lsp] Loaded extension 'esbonio.lsp.rst.roles'
[esbonio.lsp] Loaded extension 'esbonio.lsp.sphinx.autodoc'
[esbonio.lsp] Loaded extension 'esbonio.lsp.sphinx.codeblocks'
[esbonio.lsp] Loaded extension 'esbonio.lsp.sphinx.domains'
[esbonio.lsp] Loaded extension 'esbonio.lsp.sphinx.directives'
[esbonio.lsp] Loaded extension 'esbonio.lsp.sphinx.images'
[esbonio.lsp] Loaded extension 'esbonio.lsp.sphinx.includes'
[esbonio.lsp] Loaded extension 'esbonio.lsp.sphinx.roles'
[esbonio.lsp] User Config {
"buildDir": "\\C:\\Users\\Fred\\AppData\\Roaming\\Code\\User\\workspaceStorage\\6bc42b328c8545c5b5951f9afee3d749\\swyddfa.esbonio\\sphinx"
}
[esbonio.lsp] Workspace Folder: 'file:///c%3A/Users/Fred/Documents/PlatformIO/Projects/dcc-ex.github.io'
[esbonio.lsp] Sphinx Args {
"buildername": "html",
"confdir": "c:\\Users\\Fred\\Documents\\PlatformIO\\Projects\\dcc-ex.github.io\\docs",
"confoverrides": {},
"doctreedir": "c:\\Users\\Fred\\AppData\\Roaming\\Code\\User\\workspaceStorage\\6bc42b328c8545c5b5951f9afee3d749\\swyddfa.esbonio\\sphinx\\doctrees",
"freshenv": false,
"keep_going": false,
"outdir": "c:\\Users\\Fred\\AppData\\Roaming\\Code\\User\\workspaceStorage\\6bc42b328c8545c5b5951f9afee3d749\\swyddfa.esbonio\\sphinx\\html",
"parallel": 1,
"srcdir": "c:\\Users\\Fred\\Documents\\PlatformIO\\Projects\\dcc-ex.github.io\\docs",
"status": null,
"tags": [],
"verbosity": 0,
"warning": null,
"warningiserror": false
}
Running Sphinx v5.1.1
Initializing Spelling Checker 7.6.0
[esbonio.lsp] Traceback (most recent call last):
File "C:\Users\Fred\AppData\Local\Programs\Python\Python310\lib\site-packages\sphinx\registry.py", line 442, in load_extension
mod = import_module(extname)
File "C:\Users\Fred\AppData\Local\Programs\Python\Python310\lib\importlib\__init__.py", line 126, in import_module
return _bootstrap._gcd_import(name[level:], package, level)
File "<frozen importlib._bootstrap>", line 1050, in _gcd_import
File "<frozen importlib._bootstrap>", line 1027, in _find_and_load
File "<frozen importlib._bootstrap>", line 1004, in _find_and_load_unlocked
ModuleNotFoundError: No module named 'sphinx_reredirects'
The above exception was the direct cause of the following exception:
Traceback (most recent call last):
File "C:\Users\Fred\AppData\Local\Programs\Python\Python310\lib\site-packages\esbonio\lsp\sphinx\__init__.py", line 149, in _initialize_sphinx
return self.create_sphinx_app(self.user_config) # type: ignore
File "C:\Users\Fred\AppData\Local\Programs\Python\Python310\lib\site-packages\esbonio\lsp\sphinx\__init__.py", line 343, in create_sphinx_app
app = Sphinx(**self.sphinx_args)
File "C:\Users\Fred\AppData\Local\Programs\Python\Python310\lib\site-packages\sphinx\application.py", line 222, in __init__
self.setup_extension(extension)
File "C:\Users\Fred\AppData\Local\Programs\Python\Python310\lib\site-packages\sphinx\application.py", line 400, in setup_extension
self.registry.load_extension(self, extname)
File "C:\Users\Fred\AppData\Local\Programs\Python\Python310\lib\site-packages\sphinx\registry.py", line 445, in load_extension
raise ExtensionError(__('Could not import extension %s') % extname,
sphinx.errors.ExtensionError: Could not import extension sphinx_reredirects (exception: No module named 'sphinx_reredirects')
[esbonio.lsp] Publishing 1 diagnostics for: file:///c:/users/fred/appdata/local/programs/python/python310/lib/site-packages/sphinx/registry.py
[client] Build complete {
"config": {
"sphinx": {
"buildDir": "c:\\Users\\Fred\\AppData\\Roaming\\Code\\User\\workspaceStorage\\6bc42b328c8545c5b5951f9afee3d749\\swyddfa.esbonio\\sphinx\\html",
"confDir": "c:\\Users\\Fred\\Documents\\PlatformIO\\Projects\\dcc-ex.github.io\\docs",
"doctreeDir": "c:\\Users\\Fred\\AppData\\Roaming\\Code\\User\\workspaceStorage\\6bc42b328c8545c5b5951f9afee3d749\\swyddfa.esbonio\\sphinx\\doctrees",
"srcDir": "c:\\Users\\Fred\\Documents\\PlatformIO\\Projects\\dcc-ex.github.io\\docs",
"command": [
"sphinx-build",
"-M",
"html",
"c:\\Users\\Fred\\Documents\\PlatformIO\\Projects\\dcc-ex.github.io\\docs",
"c:\\Users\\Fred\\AppData\\Roaming\\Code\\User\\workspaceStorage\\6bc42b328c8545c5b5951f9afee3d749\\swyddfa.esbonio\\sphinx\\html",
"-d",
"c:\\Users\\Fred\\AppData\\Roaming\\Code\\User\\workspaceStorage\\6bc42b328c8545c5b5951f9afee3d749\\swyddfa.esbonio\\sphinx\\doctrees"
],
"version": "5.1.1"
},
"server": {
"logLevel": "debug"
}
},
"error": true,
"warnings": 0
}
[esbonio.lsp] Getting initial doctree for: 'c:\Users\Fred\Documents\PlatformIO\Projects\dcc-ex.github.io\docs\ex-csb1\index.rst'
[esbonio.lsp] c:\Users\Fred\Documents\PlatformIO\Projects\dcc-ex.github.io\docs\ex-csb1\index.rst:7: (ERROR/3) Undefined substitution referenced: "EX-CS-LOGO".
[esbonio.lsp] c:\Users\Fred\Documents\PlatformIO\Projects\dcc-ex.github.io\docs\ex-csb1\index.rst:7: (ERROR/3) Undefined substitution referenced: "donate-button".
[esbonio.lsp] c:\Users\Fred\Documents\PlatformIO\Projects\dcc-ex.github.io\docs\ex-csb1\index.rst:13: (ERROR/3) Undefined substitution referenced: "EX-CSB1".
[esbonio.lsp] c:\Users\Fred\Documents\PlatformIO\Projects\dcc-ex.github.io\docs\ex-csb1\index.rst:15: (ERROR/3) Undefined substitution referenced: "conductor".
[esbonio.lsp] c:\Users\Fred\Documents\PlatformIO\Projects\dcc-ex.github.io\docs\ex-csb1\index.rst:15: (ERROR/3) Undefined substitution referenced: "tinkerer".
[esbonio.lsp] c:\Users\Fred\Documents\PlatformIO\Projects\dcc-ex.github.io\docs\ex-csb1\index.rst:15: (ERROR/3) Undefined substitution referenced: "engineer".
[esbonio.lsp] c:\Users\Fred\Documents\PlatformIO\Projects\dcc-ex.github.io\docs\ex-csb1\index.rst:15: (ERROR/3) Undefined substitution referenced: "support-button".
[esbonio.lsp] c:\Users\Fred\Documents\PlatformIO\Projects\dcc-ex.github.io\docs\ex-csb1\index.rst:23: (ERROR/3) Undefined substitution referenced: "DCC-EX".
[esbonio.lsp] c:\Users\Fred\Documents\PlatformIO\Projects\dcc-ex.github.io\docs\ex-csb1\index.rst:32: (ERROR/3) Undefined substitution referenced: "EX-CSB1".
[esbonio.lsp] c:\Users\Fred\Documents\PlatformIO\Projects\dcc-ex.github.io\docs\ex-csb1\index.rst:129: (ERROR/3) Undefined substitution referenced: "EX-CS".
[esbonio.lsp] c:\Users\Fred\Documents\PlatformIO\Projects\dcc-ex.github.io\docs\ex-csb1\index.rst:165: (ERROR/3) Undefined substitution referenced: "EX-WT".
[esbonio.lsp] c:\Users\Fred\Documents\PlatformIO\Projects\dcc-ex.github.io\docs\ex-csb1\index.rst:165: (ERROR/3) Undefined substitution referenced: "JMRI".
[esbonio.lsp] c:\Users\Fred\Documents\PlatformIO\Projects\dcc-ex.github.io\docs\ex-csb1\index.rst:165: (ERROR/3) Undefined substitution referenced: "Engine Driver".
[esbonio.lsp] Getting initial doctree for: 'c:\Users\Fred\Documents\PlatformIO\Projects\dcc-ex.github.io\docs\ex-csb1\index.rst'
[esbonio.lsp] c:\Users\Fred\Documents\PlatformIO\Projects\dcc-ex.github.io\docs\ex-csb1\index.rst:7: (ERROR/3) Undefined substitution referenced: "EX-CS-LOGO".
[esbonio.lsp] c:\Users\Fred\Documents\PlatformIO\Projects\dcc-ex.github.io\docs\ex-csb1\index.rst:7: (ERROR/3) Undefined substitution referenced: "donate-button".
[esbonio.lsp] c:\Users\Fred\Documents\PlatformIO\Projects\dcc-ex.github.io\docs\ex-csb1\index.rst:13: (ERROR/3) Undefined substitution referenced: "EX-CSB1".
[esbonio.lsp] c:\Users\Fred\Documents\PlatformIO\Projects\dcc-ex.github.io\docs\ex-csb1\index.rst:15: (ERROR/3) Undefined substitution referenced: "conductor".
[esbonio.lsp] c:\Users\Fred\Documents\PlatformIO\Projects\dcc-ex.github.io\docs\ex-csb1\index.rst:15: (ERROR/3) Undefined substitution referenced: "tinkerer".
[esbonio.lsp] c:\Users\Fred\Documents\PlatformIO\Projects\dcc-ex.github.io\docs\ex-csb1\index.rst:15: (ERROR/3) Undefined substitution referenced: "engineer".
[esbonio.lsp] c:\Users\Fred\Documents\PlatformIO\Projects\dcc-ex.github.io\docs\ex-csb1\index.rst:15: (ERROR/3) Undefined substitution referenced: "support-button".
[esbonio.lsp] c:\Users\Fred\Documents\PlatformIO\Projects\dcc-ex.github.io\docs\ex-csb1\index.rst:23: (ERROR/3) Undefined substitution referenced: "DCC-EX".
[esbonio.lsp] c:\Users\Fred\Documents\PlatformIO\Projects\dcc-ex.github.io\docs\ex-csb1\index.rst:32: (ERROR/3) Undefined substitution referenced: "EX-CSB1".
[esbonio.lsp] c:\Users\Fred\Documents\PlatformIO\Projects\dcc-ex.github.io\docs\ex-csb1\index.rst:129: (ERROR/3) Undefined substitution referenced: "EX-CS".
[esbonio.lsp] c:\Users\Fred\Documents\PlatformIO\Projects\dcc-ex.github.io\docs\ex-csb1\index.rst:165: (ERROR/3) Undefined substitution referenced: "EX-WT".
[esbonio.lsp] c:\Users\Fred\Documents\PlatformIO\Projects\dcc-ex.github.io\docs\ex-csb1\index.rst:165: (ERROR/3) Undefined substitution referenced: "JMRI".
[esbonio.lsp] c:\Users\Fred\Documents\PlatformIO\Projects\dcc-ex.github.io\docs\ex-csb1\index.rst:165: (ERROR/3) Undefined substitution referenced: "Engine Driver".
[client] Ignoring output:extension-output-swyddfa.esbonio-%231-Esbonio
[client] Ignoring output:extension-output-swyddfa.esbonio-%231-Esbonio
[client] Ignoring output:extension-output-swyddfa.esbonio-%231-Esbonio
[client] HTML Path 'undefined'
[client] Ignoring output:extension-output-swyddfa.esbonio-%231-Esbonio
[client] HTML Path 'undefined'
[client] Ignoring output:extension-output-swyddfa.esbonio-%231-Esbonio
[client] HTML Path 'undefined'
[client] Ignoring output:extension-output-swyddfa.esbonio-%231-Esbonio
[client] HTML Path 'undefined'
(Optional) Settings from conf.py
import sphinx_rtd_theme
# -- Project information -----------------------------------------------------
project = 'xxx'
copyright = 'xxx'
author = 'xxx'
# -- General configuration ---------------------------------------------------
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autodoc',
# 'sphinx.ext.intersphinx',
'sphinx.ext.autosectionlabel',
'sphinx.ext.todo',
# 'sphinx.ext.coverage',
# 'sphinx.ext.mathjax',
# 'sphinx.ext.ifconfig',
# 'sphinx.ext.viewcode',
# 'sphinx.ext.graphviz',
'sphinx_sitemap',
# 'sphinx.ext.inheritance_diagram',
'sphinxcontrib.spelling',
'sphinx_toolbox.collapse',
'ablog',
'sphinx.ext.intersphinx',
'sphinx_design',
'sphinx_rtd_dark_mode',
'sphinx_reredirects',
# 'sphinx_last_updated_by_git',
'notfound.extension'
]
autosectionlabel_prefix_document = True
# Don't make dark mode the user default
default_dark_mode = False
spelling_lang = 'en_UK'
tokenizer_lang = 'en_UK'
spelling_word_list_filename = ['spelling_wordlist.txt']
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# 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 = [
'_build', 'Thumbs.db', '.DS_Store',
]
# Set the default for literal blocks and code-block
highlight_language = 'none'
# Automatically number figure captions
numfig = True
numfig_format = {'figure': 'Figure %s'}
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = "sphinx_rtd_theme"
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']
html_logo = "./_static/images/logo.png"
html_favicon = "./_static/images/favicon.ico"
# Added commented out lines below for 'titles_only' and 'navigation_depth'.
# If we wish to have the menu expand to lower levels than just page titles,
# uncomment these lines and comment the other option out to enable this in
# the menu.
html_theme_options = {
'style_nav_header_background': 'white',
'logo_only': True,
# Toc options
'includehidden': True,
# 'titles_only': False,
'titles_only': True,
'collapse_navigation': False,
# 'navigation_depth': 3
'navigation_depth': -1
}
html_context = {
'display_github': True,
'github_user': 'DCC-EX',
'github_repo': 'dcc-ex.github.io',
'github_version': 'sphinx/docs/',
}
# leave this off to have todos invisible, set to true to render them and make the easy to see
# A list of all the todos in the document can be shown in the about page
todo_include_todos = True
# html_additional_pages = {
# 'exwebthrottle': 'exwebthrottle/index.html',
# }
html_css_files = [
'css/dccex_theme.css',
'css/big_picture_theme.css',
'css/sphinx_design_overrides.css',
# 'css/layout.css',
# 'css/roundslider.min.css',
# 'css/throttle.css'
]
html_js_files = [
'js/platform.js',
'js/extra.js',
# 'js/commandController.js',
# 'js/exwebthrottle.js',
# 'js/fnMaster.js',
# 'js/jquery-3.2.1.min.js',
# 'js/jquery-ui.min.js',
# 'js/roundslider.min.js',
# 'js/storageController.js'
]
# Sphinx sitemap
html_baseurl = 'https://dcc-ex.com/'
html_extra_path = [
'robots.txt',
]
# ABlog options here
blog_path = 'news'
blog_title = 'DCC-EX News'
blog_baseurl = 'https://dcc-ex.com'
post_auto_excerpt = 1
post_auto_image = 0
blog_post_pattern = "news/posts/*"
blog_feed_fulltext = True
fontawesome_included = True
redirects = {
"about/press/index": "../../about/about.html",
"about/press/new-name": "https://dcc-ex.com/news/posts/20201001.html",
"about/rewrite": "https://dcc-ex.com/news/posts/20201001.html",
"advanced-setup/index": "../ex-commandstation/advanced-setup/index.html",
"advanced-setup/supported-microcontrollers/index": "../../advanced-setup/supported-microcontrollers/index.html",
"advanced-setup/supported-motorboards/index": "../../reference/hardware/motor-boards.html",
"automation/EX-RAIL-intro": "../ex-rail/index.htm",
"automation/index": "../ex-rail/index.htm",
"developer-reference/api": "../reference/developers/api.html",
"developer-reference/api": "../reference/developers/api.html",
"developer-reference/index": "../reference/developers/index.html",
"developer-reference/tech-reference": "../reference/developers/index.html",
"download/commandstation": "ex-commandstation.html",
"download/dcc-inspector-ex": "ex-dccinspector.html",
"download/documents": "index.html",
"download/schematics": "index.html",
"download/turntable-ex": "ex-turntable.html",
"ex-commandstation/advanced-setup/supported-bluetooth/index": "../../../reference/hardware/bluetooth.html",
"ex-installer/installing-original-installer": "index.html",
"ex-rail/deprecate-EX-RAIL-reference": "index.html",
"ex-rail/deprecate-EX-RAIL-summary": "index.html",
"exwebthrottle/LICENSE": "../about/licence.html",
"get-started/assembly": "../ex-commandstation/get-started/assembly.html",
"get-started/controllers": "../ex-commandstation/get-started/controllers.html",
"get-started/index": "../ex-commandstation/get-started/index.html",
"get-started/installer": "../ex-commandstation/get-started/installer.html",
"get-started/levels": "../begin/levels.html",
"get-started/wifi-setup": "../ex-commandstation/get-started/wifi-setup.html",
"glossary": "./reference/glossary.html",
"news/posts/20230310": "../../news.html",
"news/posts/20230408": "../../news.html",
"news/posts/20230806": "../../news.html",
"press/index": "../../news.html",
"press/v40-announce": "../../news.html",
"reference/developers/tech-reference": "../../throttles/tech-reference.html",
"reference/documents/decoder-table": "../../reference/hardware/decoder-list.html",
"reference/hardware/bluetooth-boards": "../../reference/hardware/bluetooth.html",
"reference/hardware/other/index": "../../reference/hardware/index.html",
"reference/hardware/shopping-list": "../../ex-commandstation/get-started/purchasing.html",
"reference/software/command-summary": "../../reference/software/command-summary-consolidated.html",
"reference/software/single-opcode-reference": "../../reference/software/command-summary-consolidated.html",
"site-map/index": "../about/site-map.html",
"support/create-ticket": "../support/index.html",
"support/makerfabs-update-at-version-with-usb-to-ttl": "../support/wifi-at-version.html#correcting-the-at-version-on-a-makerfabs-esp8266-wifi-shield",
"throttles/cab-engineer": "../throttles/software/cab-engineer.html",
"throttles/hardware/physical-knobs": "../../throttles/hardware/engine-driver-physical-knobs.html",
"throttles/physical-knobs": "../throttles/hardware/engine-driver-physical-knobs.html",
"throttles/software/ex-webthrottle": "../../ex-webthrottle/index.html",
"throttles/witcontroller": "../throttles/hardware/witcontroller.html",
"throttles/withrottle": "../throttles/software/withrottle.html",
"turntable-ex/index": "../ex-turntable/index.html",
"turntable-ex/turntable-ex": "../ex-turntable/index.html",
"under-development/track-manager": "../trackmanager/index.html",
}
# Configure sphinx-notfound-page
notfound_context = {
"title": "Page Not Found",
"body": """
<h1>Page Not Found</h1>
<p>Sorry, we couldn't find that page.</p>
<p>Try using the search box or go to the <a href="/index.html">homepage</a>.</p>
""",
}
notfound_urls_prefix = "/dcc-ex.github.io/"