Welcome to Minae’s Sphinx Test Docs

Hi, I’m Minae! I spun up this page using the Sphinx documentation generator along with the ReadTheDocs documentation hosting platform.

Sphinx is a documentation generator that’s often used with Python projects. It supports multiple output formats, including HTML, LaTeX, and PDF. Its pages (like this one) are created using a markup language called ReStructuredText. Files written with ReStructuredText use the .rst extension.

Sphinx is a static site generator (SSG), so you can deploy it through many services, including GitHub Pages, Netlify, and the other usual suspects when it comes to SSG hosting. However, most people choose to deploy Sphinx sites through ReadTheDocs because it’s a platform that specifically supports Sphinx.

Complete list of technologies used to create this page:

• Sphinx

• ReadTheDocs

• ReStructuredText

• Python 3

• pip (package installer for python)

• venv (python virtual environment)

• GitHub

• The Sphinx Press theme

• sphinx-copybutton

• A code editor (VS Code)

• Sphinx CLI

• git CLI

• bash

Note

This site is set up to automatically update whenever I push changes to GitHub, which is part of a docs-as-code CI/CD workflow.

I added an extension called sphinx-copybutton that adds a button to every code snippet to easily copy the code. To add this extension, you must install it to your Sphinx project using pip or conda, then add it to the conf.py file like this:

extensions = [
   ...
   'sphinx_copybutton',
   ...
]

Hover over the code snippet above to see the copy button appear.