Creating a Website with Sphinx and Markdown - Mouse Vs Python

Sphinx is a documentation builder that utilizes Python and supports both ReStructuredText and Markdown formats. To begin using Sphinx, install required packages in a Python virtual environment. Activate the virtual environment and install the myst-parser and sphinx packages with pip. Once set up, create a barebones Sphinx site by executing sphinx-quickstart in the terminal. The setup process may prompt users with queries about configuration, allowing for customization according to preferences or acceptance of default settings. A specific tree structure is created for managing project files.

To create a barebones Sphinx site, run the command sphinx-quickstart NAME_OF_SITE_FOLDER inside your virtual environment. It will ask you a series of questions.

You will need the following packages to be able to use Sphinx and Markdown: myst-parser and sphinx. Install them using pip after activating your virtual environment.

Read at Mouse Vs Python