How to Python in VS Code 🦄

An Opinionated Guide

Read the free guide at py-vscode.readthedocs.io

This is an ongoing work. I need contributors. Specially, if you are doing python in VS Code on MacOS/Windows, please consider contributing.

Contribution Guidelines

• This guideline has been made with Sphinx and served with Read The Docs ❤️

• The pages are written in markdown.md format and are located in docs/files/ folder. If you want to make an edit (You're awesome 👍)

  • Clone the repo
  • Make your changes to the files in docs/files/
  • And send me a pull request

• If you want to extend/add new pages to the guideline (Whoa, I owe you one 🔥)

  • Clone the repo
  • Make add new newfile.md in docs/files folder
  • Write your contents in markdown format
  • Add the new section in docs/index.rst file
  • And send me a pull request

• If you want to build the website locally after making an edit (Please Breed 🔱)

  • Make a python environment, activate it and install the requirements via:

  pip install -r requirements.txt

  • Make your changes according to the above guildelines
  • From the root directory, run:

  sphinx-build -b html docs/ docs/_build

  • Navigate to docs/_build/files to find your newly built html pages. Open them in your browser for inspection.
  • If you are satisfied with your edits, send me a pull request.