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

Add "build all" command to VSCode extension #445

Open
ghost opened this issue Aug 29, 2022 · 6 comments
Open

Add "build all" command to VSCode extension #445

ghost opened this issue Aug 29, 2022 · 6 comments
Labels
enhancement New feature or request ide:vscode Issues that relate to the Esbonio vscode extension
Milestone

Comments

@ghost
Copy link

ghost commented Aug 29, 2022

A would like to see a "build all" command in the VSCode extension.

This is really helpfull when editing a toctree directive. The toctree isn't automatically updated on other pages, only when saving them again. So each and every page must be saved to inherit the updated toctree.

@davbeek
Copy link

davbeek commented Aug 29, 2022

I don't know if I am missing something, but I have pinned the command to restart the language server, so it is only a click away. I use it often. I have a large website to build, but rebuild all by restarting the language server is really fast and waiting is zero issue for me.

@ghost
Copy link
Author

ghost commented Aug 29, 2022

Maybe I'm missing something too, but in my case, the table of contents in the sidebar isn't updated, even when I restart the language server. I'm using the sphinx-book-theme.

@alcarney alcarney added enhancement New feature or request ide:vscode Issues that relate to the Esbonio vscode extension labels Aug 29, 2022
@alcarney
Copy link
Member

the table of contents in the sidebar isn't updated, even when I restart the language server

Sounds like Sphinx's caching is getting in the way.

Currently there is an esbonio.sphinx.forceFullBuild option you can try that should force Sphinx to build everything when the server restarts.

But a command that only triggers a full build sounds like a good idea :)

@ghost
Copy link
Author

ghost commented Aug 30, 2022

Currently there is an esbonio.sphinx.forceFullBuild option you can try that should force Sphinx to build everything when the server restarts.

Thanks for pointing out the option, I must have overlooked it. Restarting the language server now updates the sidebar TOC as it should.

But a command that only triggers a full build sounds like a good idea :)

I'm glad to hear that!

@davbeek
Copy link

davbeek commented Aug 30, 2022

in my case, the table of contents in the sidebar isn't updated, even when I restart the language server.

When you delete the Sphinx/Esbonio build folder before restarting the language server, the complete website is rebuilt, but you will need to close and reopen the Esbonio previewer when the language server is finished rebuilding.

I use the Esbonio setting "esbonio.sphinx.buildDir": "${workspaceFolder}/_build/html" to have the build dir (_build/html) at the top level of my VSCode workspace, for easy access.

@alcarney alcarney added this to Esbonio Jan 14, 2023
@github-project-automation github-project-automation bot moved this to Todo in Esbonio Jan 14, 2023
@alcarney alcarney added this to the 1.0 milestone Apr 23, 2024
@alcarney
Copy link
Member

As well as a "build all" command, there should be the option to clear the build folder and start from scratch

See: #609 (comment)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request ide:vscode Issues that relate to the Esbonio vscode extension
Projects
Status: Todo
Development

No branches or pull requests

2 participants