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 devcontainer config option for development #2272

Merged
merged 2 commits into from
Dec 19, 2024

Conversation

nickspaargaren
Copy link
Contributor

@nickspaargaren nickspaargaren commented Dec 18, 2024

What

  • Adds dev container config for easy development.
  • In addition to local development with Python venv, this PR adds the Docker dev container option.

Requirements

How to test

  • Checkout this branch.
  • Open a supported IDE.
  • Click the "Open in devcontainer" popup.
  • Run cd docs/ && make livehtml for example to start the project.
  • Click the "Open in Browser" popup.
  • Project should start like normal on http://127.0.0.1:8888
  • Happy developing!

📚 Documentation preview 📚: https://writethedocs-www--2272.org.readthedocs.build/

@ericholscher ericholscher enabled auto-merge (squash) December 18, 2024 23:36
Copy link
Contributor

@plaindocs plaindocs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh cool!

@nickspaargaren would you mind throwing the instructions into the README.md?

@ericholscher ericholscher merged commit 06bf0fc into writethedocs:main Dec 19, 2024
6 checks passed
@nickspaargaren
Copy link
Contributor Author

Oh cool!

@nickspaargaren would you mind throwing the instructions into the README.md?

Sure, here you go !

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants