Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Esbonio doesn't work when conf.py not in source directory #142

Closed
AkibAzmain opened this issue Mar 18, 2021 · 2 comments · Fixed by #161
Closed

Esbonio doesn't work when conf.py not in source directory #142

AkibAzmain opened this issue Mar 18, 2021 · 2 comments · Fixed by #161
Assignees
Labels
bug Something isn't working lsp Issues that relate to the language server

Comments

@AkibAzmain
Copy link

I'm using the Esbonio VSCode extension (version 0.5.1). It works very well. But if I move conf.py to some other place, the language server fails.

I'm using Sphinx 3.4.3 with GNU Autotools. I have a template file named conf.py.in, from which conf.py is generated by the configure script (you should be familiar be this if you compile software from source code).

I tried to find a setting with changes Sphinx arguments but found none.

Sphinx: 3.4.3
Esbonio: 0.5.1
Autoconf: 2.59

@alcarney
Copy link
Member

The language server does assume that your *.rst files are in the same directory as conf.py, something that's currently hard coded into the initialisation code. I imagine a fix for this will also flush out a way to resolve #62....

Is this something you want to have a go at fixing? (#143 made it sound like you might), if so could you assign the issue to yourself so that I know to focus on something else :)

@alcarney alcarney added bug Something isn't working lsp Issues that relate to the language server labels Mar 22, 2021
@github-actions github-actions bot added this to Backlog in Language Server Mar 22, 2021
@alcarney alcarney moved this from Backlog to To do (For next release) in Language Server Apr 21, 2021
@alcarney alcarney self-assigned this May 5, 2021
@github-actions github-actions bot moved this from To do (For next release) to In progress in Language Server May 5, 2021
Language Server automation moved this from In progress to Done (Ready to release) May 7, 2021
@alcarney
Copy link
Member

alcarney commented May 8, 2021

v0.6.0 of both the Language Server and the VSCode extension was just released which will now let you override the default srcdir Sphinx is configured with. You can set the esbonio.sphinx.srcDir option to either

  • /an/absolute/path/to/your/srcdir
  • ${confDir}/../srcdir - a path relative to the folder containing your conf.py
  • ${workspaceRoot}/your/srcdir - a path relative to the workspace root.

Hopefully that resolves your issue but feel free to reopen this if it doesn't!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working lsp Issues that relate to the language server
Projects
No open projects
Language Server
Done (Ready to release)
Development

Successfully merging a pull request may close this issue.

2 participants