Setting up Sphinx and VSCode on Windows.

This document describes how to get Sphinx-Doc running on a windows machine including the required software for editing, version control and building of the document package files. It also goes into some detail on configuring this software and some basic conventions for RST documents editing.

A good, quick overview of Sphinx and how to set it up natively (using the OS python instead of a docker package) can be found at the following youtube playlist.

Note

We will be using python provided by Docker - so our procedure is a little different.

Contents:

• Introduction and Installation
  • Prerequisites and method
• Install Rancher
  • Download Rancher
  • Continue install
  • Don’t restart - yet
  • Configure the engine
  • Close and restart
  • Logging back in
  • Wait for WSL2 deployment
  • Pull required docker images
  • Install progress
  • Verify images in Rancher desktop
• Install Git and Python
  • Download Git
  • Continue Installation
  • Setup Git user
  • Download Github CLI
  • Continue Installation
  • Download Python
• Install Visual Studio Code
  • Download Visual Studio Code
  • Continue installation
  • Final Confguration of Visual Studio Code
    • Setup some key bindings
    • Install more extensions
• Working with Repositories
  • How to fork a repository
• Editing Sphinx documents
  • What’s in the repo?
  • Live Server
  • Build HTML and PDF documentation