Easy-versioning 1.0.1

A Sphinx extension/tool to manage multi-version and multi-language documentation builds without relying on ReadTheDocs.

Easy Versioning (Sphinx documentation build framework)

This framework was created to address the need for adding versioning to a Sphinx project without relying on Read the Docs (RTD).

This Python script automates the full workflow of preparing, versioning, building, and organizing documentation from Markdown files using the Sphinx Framework.

It’s designed for teams and organizations who want to self-host their documentation sites and prefer full control over the hosting environment and theme customization.
Easy Versioning works as an alternative approach for managing versioned and multilingual docs, complementing existing Sphinx workflows in a simple way with only one framework.

By organizing your source files in the expected structure, this framework actively builds your documentation with Sphinx and outputs a fully ready-to-deploy static site.
With minimal setup, it streamlines the process of managing multiple versions and languages, adding consistent footers, and arranging build artifacts for deployment.

---

Features

This project allows you to:

• Manage multiple documentation versions
• Support multiple languages for each version
• Add custom footers showing version and language info
• Security by ensuring a safe fallback to an existing page so users are always redirected proprely
• Build documentation automatically using Sphinx for every version and language
• Organize generated HTML files into a clean, ready-to-deploy structure

---

Prerequisites

Make sure you have the following installed on your system:

• Python version >= 3.8
• Install the required Python libraries using pip install -r requirements.txt

---

Folders set-up

📦 Easy_versioning_Sphinx/
├── 📂 data/
│ └── 📄 Footer.md
├── 📂 src/
│ ├── 📁 V. X.XX/
│ │ ├── 🌐 Language 1/
│ │ │ └── 📘 Language 1 Sphinx Project/
│ │ └── 🌐 Language 2/
│ │ └── 📘 Language 2 Sphinx Project/
│ ├── 📁 V. Y.YY/
│ ├── 📁 V. Y.YY/

Why use this?

Easy Versioning offers:

✅ A ready-to-deploy website, already structured in the output folder
✅ Full control of your hosting and deployment
✅ Freedom to use any Sphinx theme or customization
✅ Safe fallback automatically redirects users to a valid page if their requested version or language is unavailable ✅ A simple and consistent workflow for large, multilingual, versioned docs

This framework is not a replacement for ReadTheDocs but rather a complementary free solution for teams who prefer to host their own documentation or require a different setup.