Setup docs site

README.md

@@ -6,7 +6,7 @@ Puts a small, bored cat, an enthusiastic dog, a feisty snake, a rubber duck, or
 
 [![Visual Studio Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/tonybaloney.vscode-pets?color=blue&logo=visual-studio)](https://marketplace.visualstudio.com/items?itemName=tonybaloney.vscode-pets&WT.mc_id=python-17801-anthonyshaw)
 
-![screenshot](https://github.com/tonybaloney/vscode-pets/raw/master/screenshots/screenshot.gif)
+![screenshot](https://github.com/tonybaloney/vscode-pets/raw/master/docs/source/_static/screenshot.gif)
 
 ## Installation
 
@@ -26,145 +26,13 @@ With VS Code open, launch VS Code Quick Open (`Ctrl+P` on Windows/Linux or `Cmd(
 
 Congrats on installing joy! Enjoy interacting with these cute pixelated pets. Read below to get a full understanding of this extension. Not convinced? Watch our extension spotlight on [Visual Studio Code](https://www.youtube.com/watch?v=aE6Ifj_KstI).
 
-Available commands are prefaced with `Pet Coding` in the Command Palette:
-* Start pet coding session
-* Spawn extra pet
-* Throw ball
-* Roll-call
-* Remove pet
-* Remove all pets
+After installing, open the command palette with `Ctrl+Shift+P` on Windows/Linux or `Cmd(⌘)+Shift+P` on MacOS.  
 
-## Configure vscode-pets in the VS Code settings
+Run the "Start pet coding session" command (`vscode-pets.start`) to see a cat in VS Code:
 
-Open the setting panel with `Ctrl+,` on Windows/Linux or `Cmd(⌘)+,` on MacOS. In the search bar, enter “vscode-pets” to see all available options.
+![Default view](https://github.com/tonybaloney/vscode-pets/raw/master/docs/source/_static/pet-in-default-explorer.png)
 
-Set a default color, size, pet type, position, and theme when you open a Pet Panel.
-
-* Pet Color: black, brown, green, yellow, gray, purple, red, white
-* Pet Size: nano, medium, large
-* Pet Type: cat, crab, clippy, cockatiel, dog, mod, rocky, rubber duck, snake, totoro, zappy
-* Position: panel, explorer
-* Theme: none, forest, castle, beach
-
-![screenshot2](https://github.com/tonybaloney/vscode-pets/raw/master/screenshots/screenshot-2.gif)
-
-### Restrictions
-
-* Snake can only be green
-* Rubber duck & Zappy can only be yellow
-* Ferris the crab can only be red
-* Rocky can only be gray
-* Mod can only be purple
-
-## Start pet coding session to show your pet
-
-Open the command palette with `Ctrl+Shift+P` on Windows/Linux or `Cmd(⌘)+Shift+P` on MacOS.  
-
-Run the "Start pet coding session" command (`vscode-pets.start`)
-
-## Playing
-
-Pets will interact with your mouse pointer within the open Pet Panel. Additionally, pets will display text bubbles as you move your mouse over the pet.
-
-![screenshot3](https://github.com/tonybaloney/vscode-pets/raw/master/screenshots/screenshot-3.gif)
-
-## Adding extra pets
-
-Run the "Spawn additional pet" command (`vscode-pets.spawn-pet`) and select the pet type and color.
-
-Extra pets will not persist between closing and restarting VS Code.
-
-![pet-select](https://github.com/tonybaloney/vscode-pets/raw/master/screenshots/pet-select.png)
-
-## Throwing a ball
-
-Play catch with your pet! Run the "Throw ball" command (`vscode-pets.throw-ball`).
-
-* Rocky will not run & catch a ball. Have you ever seen a rock run after a ball? Neither have we.
-
-![screenshot4](https://github.com/tonybaloney/vscode-pets/raw/master/screenshots/screenshot-4.gif)
-
-## Roll-call with your pets
-
-Get a description of your current pets within VS Code. Run the "Roll-call" command (`vscode-pets.roll-call`) from the command palette.
-
-![pet-roll-call](https://github.com/tonybaloney/vscode-pets/raw/master/screenshots/pet-roll-call.png)
-
-## Removing a single pet or multiple pets
-
-You can remove all pets (except the 1 configured) by running the "Remove all pets" command (`vscode-pets.delete-pets`) from the command palette.
-
-You can remove specific pets by running the "Remove pet" command (`vscode-pets.delete-pet`) from the command palette.
-
-![pet-remove](https://github.com/tonybaloney/vscode-pets/raw/master/screenshots/pet-remove.png)
-
-## Themes
-
-Configure `vscode-pets.theme` to `"forest"` and let your pets play in a spooky forest.
-
-![forest](https://github.com/tonybaloney/vscode-pets/raw/master/screenshots/forest.gif)
-
-Set `vscode-pets.theme` to `"castle"` for them to roam the ramparts!
-
-![castle](https://github.com/tonybaloney/vscode-pets/raw/master/screenshots/castle.gif)
-
-Set `vscode-pets.theme` to `"beach"` for your friends to play by the ocean.
-
-![beach](https://github.com/tonybaloney/vscode-pets/raw/master/screenshots/beach-pose.png)
-
-## Contributing
-
-### Ideas and discussion
-
-Have an awesome idea for a new feature? Please [open an issue](https://github.com/tonybaloney/vscode-pets/issues/new) describing your idea! You can also help by reviewing some of the [existing ideas](https://github.com/tonybaloney/vscode-pets/issues) and leaving your opinion.
-
-### Reporting bugs
-
-Something is not working as it should? Please [open an issue](https://github.com/tonybaloney/vscode-pets/issues/new) giving as much information as you can. Writing an effective bug report is a valuable skill as a Software Engineer, refer to the given example below for advice.
-
-**Title** - Clearly summarize what the bug is with specific details.  
-**Summary** - If the title is too long, include a summary with additional details.  
-**Visual/Screenshot** - A picture is always worth the time. Include one if possible.  
-**Expected/Actual Results** - Explain what you expected to happen and what actually happened.  
-**Steps to Reproduce** - The steps to follow should be comprehensive, easy to understand, and short. We want to experience the bug first-hand.  
-**Environment** - Share the current version information by copying from `Help` and clicking `About`.
-
-```
-Version: 1.72.0  
-Commit: 64bbfbf67ada9953918d72e1df2f4d8e537d340e  
-Date: 2022-10-04T23:20:47.539Z
-Electron: 19.0.17
-Chromium: 102.0.5005.167
-Node.js: 16.14.2
-V8: 10.2.154.15-electron.0
-OS: Linux x64 5.19.12-200.fc36.x86_64
-Sandboxed: No
-```
-
-### Write code
-
-Want to contribute to vscode-pets? Feel free to [fork the repository](https://github.com/tonybaloney/vscode-pets/fork) and submit a pull request.
-
-### Drawing and Animations
-
-If you want to contribute improvements to the animations, additional pet colors or even new pets, clone the repository and work in the `media/` folder.  
-
-Most drawings are done in [aseprite](https://www.aseprite.org/) because you can edit GIFs directly. However, you are free to use any tool to make the animations. Animations should be 8 frames per second. The style of the extension is to have pixelated creatures (although not limited to an 8-bit color canvas).  
-
-Don't worry if you don't have enough coding experience to add the changes to the extension to support the new animations, we can help you with that.  
-
-The minimum set of behaviors is:
-* standing
-* walking
-* running/chasing
-* holding green ball
-
-### Testing the changes  
-
--   Run `npm install`.
--   Run `npm run compile`.
--   Go to the debug panel on the sidebar and launch the development version with the extension loaded (first option in the debug profiles).
--   Refer to [VS Code Extension Documentation](https://code.visualstudio.com/api) for additional resources.
+[Now checkout the documentation to see what else is possible!](https://tonybaloney.github.io/vscode-pets)
 
 ## Credits
 

docs/.gitignore

@@ -0,0 +1 @@
+build/

docs/source/conf.py

@@ -27,8 +27,7 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = [
-]
+extensions = ['sphinx.ext.autosectionlabel']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -49,4 +48,20 @@
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ['_static']
+html_logo = 'logo.png'
+html_css_files = [
+      "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0/css/fontawesome.min.css",
+      "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0/css/solid.min.css",
+      "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0/css/brands.min.css",
+]
+html_theme_options = {
+    "footer_icons": [
+        {
+            "name": "GitHub",
+            "url": "https://github.com/tonybaloney/vscode-pets",
+            "html": "",
+            "class": "fa-solid fa-github fa-2x",
+        },
+    ],
+}

docs/source/contributing.rst

@@ -0,0 +1,59 @@
+Contributing
+------------
+
+Ideas and discussion
+++++++++++++++++++++
+
+Have an awesome idea for a new feature? Please `open an issue <https://github.com/tonybaloney/vscode-pets/issues/new>`_ describing your idea! You can also help by reviewing some of the `existing ideas <https://github.com/tonybaloney/vscode-pets/issues>`_ and leaving your opinion.
+
+Reporting bugs
+++++++++++++++
+
+Something is not working as it should? Please `open an issue <https://github.com/tonybaloney/vscode-pets/issues/new>`_ giving as much information as you can. Writing an effective bug report is a valuable skill as a Software Engineer, refer to the given example below for advice.
+
+**Title** - Clearly summarize what the bug is with specific details.  
+**Summary** - If the title is too long, include a summary with additional details.  
+**Visual/Screenshot** - A picture is always worth the time. Include one if possible.  
+**Expected/Actual Results** - Explain what you expected to happen and what actually happened.  
+**Steps to Reproduce** - The steps to follow should be comprehensive, easy to understand, and short. We want to experience the bug first-hand.  
+**Environment** - Share the current version information by copying from `Help` and clicking `About`.
+
+
+   Version: 1.72.0  
+   Commit: 64bbfbf67ada9953918d72e1df2f4d8e537d340e  
+   Date: 2022-10-04T23:20:47.539Z
+   Electron: 19.0.17
+   Chromium: 102.0.5005.167
+   Node.js: 16.14.2
+   V8: 10.2.154.15-electron.0
+   OS: Linux x64 5.19.12-200.fc36.x86_64
+   Sandboxed: No
+
+Write code
+++++++++++
+
+Want to contribute to vscode-pets? Feel free to `fork the repository <https://github.com/tonybaloney/vscode-pets/fork>`_ and submit a pull request.
+
+Drawing and Animations
+++++++++++++++++++++++
+
+If you want to contribute improvements to the animations, additional pet colors or even new pets, clone the repository and work in the `media/` folder.  
+
+Most drawings are done in `aseprite <https://www.aseprite.org/>`_ because you can edit GIFs directly. However, you are free to use any tool to make the animations. Animations should be 8 frames per second. The style of the extension is to have pixelated creatures (although not limited to an 8-bit color canvas).  
+
+Don't worry if you don't have enough coding experience to add the changes to the extension to support the new animations, we can help you with that.  
+
+The minimum set of behaviors is:
+
+* standing
+* walking
+* running/chasing
+* holding green ball
+
+Testing the changes  
++++++++++++++++++++
+
+-   Run `npm install`.
+-   Run `npm run compile`.
+-   Go to the debug panel on the sidebar and launch the development version with the extension loaded (first option in the debug profiles).
+-   Refer to `VS Code Extension Documentation <https://code.visualstudio.com/api>`_ for additional resources.