t-doc

This site describes the document publishing 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 sources change.

• An automatic deployment system that builds sites and deploys them to GitHub Pages on every version control push.

t-doc builds on top of the following open-source software, among others:

• Sphinx: A documentation generation system, with several extensions:

  • 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 Sphinx theme based on the PyData Sphinx Theme.

• CodeMirror: A code editor component.

• Pyodide: A Python distribution for the browser based on WebAssembly, integrated via Polyscript.

• SQLite WASM: A build of SQLite to WebAssembly.

• MathJax: A display engine for mathematics.

• JSXGraph: A JavaScript library for interactive geometry, function plotting, charting and data visualization.

• Chart.js: A JavaScript charting library.

A huge thank you to the developers and maitainers of these packages, for building awesome software and making it available for free!