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

docs: live preview (without VS Code) #181

Open
AlexanderLanin opened this issue Jan 17, 2025 · 2 comments
Open

docs: live preview (without VS Code) #181

AlexanderLanin opened this issue Jan 17, 2025 · 2 comments
Labels
docs-as-code good first issue Good for newcomers infrastructure General Score infrastructure topics

Comments

@AlexanderLanin
Copy link
Member

AlexanderLanin commented Jan 17, 2025

Provide the ability of a live preview outside of VS Code.
People are using different IDEs, and we cannot do a full integration into all of them.
But we can provide a generic preview ability, e.g. sphinx-autobuild.

Task:

  • document why we use sphinx-autobuild (or some alternative)
  • implement solution
@AlexanderLanin AlexanderLanin added infrastructure General Score infrastructure topics docs-as-code labels Jan 21, 2025
@AlexanderLanin AlexanderLanin changed the title docs: live preview docs: live preview (without VS Code) Jan 22, 2025
@AlexanderLanin AlexanderLanin added the good first issue Good for newcomers label Jan 28, 2025
@hoe-jo
Copy link

hoe-jo commented Jan 29, 2025

We also could provide additional configs, we are working on a configuration for Clion

@AlexanderLanin
Copy link
Member Author

We also could provide additional configs, we are working on a configuration for Clion

Let's create a separate issue for CLion if we want to support that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs-as-code good first issue Good for newcomers infrastructure General Score infrastructure topics
Projects
Development

No branches or pull requests

2 participants