This site is built using ...
- Read the Docs is a Continuous Documentation Deployment platform designed to simplify the process of building, versioning, and hosting technical documentation, particularly for software projects. It operates on the principle of "docs as code," integrating with version control systems like Git (GitHub, GitLab, Bitbucket) to automatically build and update documentation whenever changes are committed to the repository.
- Alabaster is a visually (c)lean, responsive, configurable theme for the Sphinx documentation system. It requires Python 3.10 or newer and Sphinx 6.2 or newer.
- CSS, or Cascading Style Sheets, is a stylesheet language used to describe the presentation and styling of a document written in a markup language, most commonly HTML. It is a fundamental technology of the World Wide Web, working alongside HTML and JavaScript to create interactive and visually appealing websites.
- HTML, or Hypertext Markup Language, is the standard language for creating web pages and structuring their content. It uses tags to define elements like headings, paragraphs, and images, telling a web browser how to display them. HTML is the foundational building block of the internet, providing the structure that is then styled with languages like CSS and made interactive with JavaScript.
- JavaScript is a programming language and core technology of the web platform, alongside HTML and CSS. Ninety-nine percent of websites on the World Wide Web use JavaScript on the client side for webpage behavior. Web browsers have a dedicated JavaScript engine that executes the client code.
- JSON, or JavaScript Object Notation, is a lightweight data-interchange format that is easy for humans to read and easy for machines to parse. It's widely used to transmit data between a server and a web application and is a common format for APIs and configuration files. While its roots are in JavaScript, JSON is language-independent and supported by most modern programming languages.
- Makefiles are text files that contain instructions for the make utility, a build automation tool commonly used in Unix-like operating systems. They define how to build or update target files (like executables or libraries) from source files, managing dependencies and executing commands.
- Python is a programming language that lets you work quickly and integrate systems more effectively.
- reStructuredText (RST) is a lightweight markup language designed for creating easy-to-read and easy-to-write plaintext documents that can be automatically converted to various output formats, such as HTML, LaTeX (and thus PDF), and more. It is a key component of the Docutils project and is widely used in the Python community for writing technical documentation, including Python's official documentation and documentation for many Python libraries.
- Sphinx is a powerful and widely-used documentation generator written in Python. It is particularly popular within the Python community and is considered the de facto standard for documenting Python projects.
- YAML is a human-readable data serialization language commonly used for configuration files and data exchange between programming languages. It uses Python-style indentation and key-value pairs to represent data structures, making it easy to read and write.
Run the following commands from the repository root to create the Sphinx documentation with Make:
cd doc
pip install -r requirements-docs.txt
make htmlFor hot reloading on Nix like OS run make livehtml
The generated HTML site will be in the doc/build/html folder.
You can open the HTML files with your web browser.
© 2025 64 Shades