t-doc#
This site describes the documentation system that forms the base of the
t-doc.org site. It is distributed as a single Python package
(t-doc-common) under the
MIT license, and consists of the following
components:
A Sphinx theme that fine-tunes the Sphinx Book Theme.
A Sphinx extension that adds functionality through roles and directives.
A local server that automatically rebuilds documents when their source changes.
A automatic deployment system. that builds sites and deploys them to GitHub Pages on every version control push.
t-doc builds on the following software:
Sphinx: A documentation generation system.
MyST: A Markdown flavor for technical and scientific communication and publication.
MyST Parser: A Sphinx extension to parse MyST source documents.
Sphinx Book Theme: A theme with a modern book-like look and feel, based on the PyData Sphinx Theme.
Sphinx Design: A Sphinx extension for screen-size responsive web components.
MathJax: A display engine for mathematics.
CodeMirror: A code editor component.
Pyodide: A Python distribution for the browser based on WebAssembly, integrated through Polyscript.
SQLite WASM: A build of SQLite to WebAssembly that enables the use of SQLite in the browser.
A huge thank you to the developers and maitainers of these packages, for building awesome software and making it available for free!