tiararodney/sphinxcontrib-theme-web2
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
7 commits 2 branches 0 tags 203 KiB
Find a file
Rodney, Tiara a97a585d39
chore: remove redundant directory 
Whatever I was trying to achieve with this...
2025-03-22 22:55:15 +01:00
src/sphinx_victorykit_theme init 2024-04-07 22:32:31 +02:00
tests init 2024-04-07 22:32:31 +02:00
vendor feat(vendor): init html-theme-ref vendor 2025-03-22 22:52:51 +01:00
.gitignore init 2024-04-07 22:32:31 +02:00
.gitmodules feat(vendor): init html-theme-ref vendor 2025-03-22 22:52:51 +01:00
babel.cfg init 2024-04-07 22:32:31 +02:00
Pipfile init 2024-04-07 22:32:31 +02:00
Pipfile.lock init 2024-04-07 22:32:31 +02:00
pyproject.toml init 2024-04-07 22:32:31 +02:00
README.md feat(vendor): init html-theme-ref vendor 2025-03-22 22:52:51 +01:00
setup.cfg init 2024-04-07 22:32:31 +02:00
setup.py init 2024-04-07 22:32:31 +02:00
tox.ini init 2024-04-07 22:32:31 +02:00

README.md

Tiara's Sphinx Theme Reference Implementation

Heads up: This is a work-in-progress reference implementation to showcase how Tiara's HTML Theming Reference can integrate with a from-scratch Sphinx documentation theme. I'll be working backwards, so expect the project to align with this README, not the other way around.

This implementation is designed to elevate Sphinx documentation through a modular, standards-driven approach. Built from the ground up using Tiara's HTML Theming Reference, this project reflects a commitment to accessibility, frugality, and adherence to the UNIX philosophy.

What This Is

  • A minimalistic yet extensible Sphinx theme built with a CSS-first mindset.
  • A reference implementation to show how HTML themes can integrate seamlessly with Sphinx.
  • A template for developers aiming to build documentation themes with clarity and modularity in mind.

What This Is NOT

  • A pre-packaged Sphinx theme ready for production use.
  • A general-purpose theming framework—this is specific to the philosophy behind Tiara's HTML Theming Reference.

Why Use This?

For developers seeking a straightforward and modular solution, this reference implementation provides a clear and adaptable foundation. It’s designed to empower users to create documentation themes that reflect their specific requirements without unnecessary complexity.

Key Principles:

  1. Accessibility First

Fully compliant with a11y standards to make documentation inclusive

  1. Frugal Engineering

Lightweight, efficient design for optimal performance.

  1. CSS First

Declarative styling ensures better maintainability.

  1. UNIX Philosophy

Each piece does one thing well—and nothing more.

  1. Customizability

Easily adapt the theme to suit your documentation needs.

Goals

This project demonstrates how Tiara's HTML Theming Reference integrates with documentation platforms like Sphinx by:

  • Showcasing Modularity: Focusing on separation of concerns for clean, maintainable code.
  • Exploring Scalability: Demonstrating how to standardize HTML theming across platforms.
  • Promoting Standards: Adhering to W3C, accessibility guidelines, and UNIX principles.

For the philosophy behind this, see Tiara's HTML Theming Reference README.

Getting Started

  1. Clone the Repo
git clone https://bitbucket.org/tiaracodes/sphinx-theme-ref.git
  1. Install dependencies (POSIX-ish shells)
sh ./configure
  1. Install dependencies (Microsoft PowerShell)
git submodule update --init --remote --recursive && npm install
  1. Preview and experiment

TODO