tiararodney/sphinxcontrib-theme-web2
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
38 commits 2 branches 0 tags 203 KiB
Find a file
Rodney, Tiara 878bd13f03
chore(vendor): integrate theme updates 
Well... I really have to come up with a convention of describing integration of
submodule changes. Feels a bit repetitive to describe what the changes are when
they're already described in the commits of the submodule itself...
2025-04-01 22:59:11 +02:00
src/sphinx_theme_ref chore(src): reinit theme configuration 2025-03-29 20:13:35 +01:00
vendor chore(vendor): integrate theme updates 2025-04-01 22:59:11 +02:00
.gitignore feat(build): initialize build configuration 2025-03-23 00:19:58 +01:00
.gitmodules chore: update repo base urls 2025-03-31 22:03:20 +02:00
ARCHITECTURE.md doc(ARCHITECTURE): init 2025-03-23 01:48:16 +01:00
configure chore: cascade vendor initialization 2025-03-23 21:05:26 +01:00
configure.ac chore: cascade vendor initialization 2025-03-23 21:05:26 +01:00
Makefile feat(build): add build target 2025-03-29 20:07:37 +01:00
Pipfile feat(build): add build target 2025-03-29 20:07:37 +01:00
Pipfile.lock feat(build): add build target 2025-03-29 20:07:37 +01:00
pyproject.toml chore: adopt PEP-639 2025-03-29 23:24:10 +01:00
README.md chore: update repo base urls 2025-03-31 22:03:20 +02:00
requirements-dev.txt feat(build): add build target 2025-03-29 20:07:37 +01:00
requirements.txt chore: init base dependency management 2025-03-22 23:53:17 +01: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