Added Documentation Support to vscode.py

TrueMyst commented 10 months ago

🍀 In this pull request, I've added the documentation support to this project in sphinx!

Documentation Tree Structure:

Getting Started/~
    - Installation
    - Creating your first extension
    - Publishing Extensions

API Reference/~
    - Commands
    - Configuration
    - Enums
    - Extension
    - Objects
    - Windows

Miscellaneous/~
    - Changelog
    - License

Feel free to make any changes to the structure! I just did the bare minimum only.

Only the part where adding the docstrings to the functions/classes are left. That would be pretty easy, I believe as sphinx will automatically detect that!

If you're done adding the docstrings, make sure to delete everything under ~/vscode.py/docs/_build/ for a clean build! After that, run make html, all the html files will be generated. Good luck!

CodeWithSwastik commented 9 months ago

Hi, thanks for the PR. You seem to have pushed the build files too by mistake. Could you delete those and update the gitignore?

CodeWithSwastik commented 9 months ago

Looks good, let's merge it

CodeWithSwastik / vscode.py

Added Documentation Support to vscode.py #50