Skip to content

Commit

Permalink
Link to the documentation of the main dependencies.
Browse files Browse the repository at this point in the history
  • Loading branch information
rblank committed Dec 12, 2024
1 parent 3ad7bcf commit 6ff80d4
Show file tree
Hide file tree
Showing 4 changed files with 62 additions and 5 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@

[![Publish](https://github.com/t-doc-org/common/actions/workflows/publish.yml/badge.svg)](https://github.com/t-doc-org/common/actions/workflows/publish.yml)
[![Package](https://github.com/t-doc-org/common/actions/workflows/package.yml/badge.svg)](https://github.com/t-doc-org/common/actions/workflows/package.yml)
[![PyPI](https://img.shields.io/pypi/v/t-doc-common.svg?color=blue)](https://pypi.org/project/t-doc-common/)

This package contains the common functionality for documents based on t-doc.
This package contains the common functionality for documents based on t-doc. See
the [documentation](https://t-doc.org/common/) for more information.

This software is distributed under the [MIT](LICENSE.txt) license.
43 changes: 42 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,48 @@

# t-doc

This documentation describes how to install and use t-doc.
This site describes the **documentation system** that forms the base of the
[t-doc.org](https://t-doc.org) site. It is distributed as a single Python package
([`t-doc-common`](https://pypi.org/project/t-doc-common/)) under the
[MIT](https://opensource.org/license/mit) license, and consists of the following
components:

- A **Sphinx theme** that fine-tunes the
[Sphinx Book Theme](https://sphinx-book-theme.readthedocs.io/).
- A **Sphinx extension** that adds functionality through
[roles and directives](reference/elements.md).
- A **[local server](edit.md#edit-documents)** that automatically rebuilds
documents when their source changes.
- A **[automatic deployment system](edit.md#deploy-documents).** that builds
sites and deploys them to [GitHub Pages](https://pages.github.com/) on every
version control push.

t-doc builds on the following software:

- **[Sphinx](https://www.sphinx-doc.org/):** A documentation generation system.
- **[MyST](https://mystmd.org/):** A
[Markdown](https://en.wikipedia.org/wiki/Markdown) flavor for technical and
scientific communication and publication.
- **[MyST Parser](https://myst-parser.readthedocs.io/):** A Sphinx extension to
parse MyST source documents.
- **[Sphinx Book Theme](https://sphinx-book-theme.readthedocs.io/):** A theme
with a modern book-like look and feel, based on the
[PyData Sphinx Theme](https://pydata-sphinx-theme.readthedocs.io/).
- **[Sphinx Design](https://sphinx-design.readthedocs.io/):** A Sphinx extension
for screen-size responsive web components.
- **[MathJax](https://www.mathjax.org/):** A display engine for mathematics.
- **[CodeMirror](https://codemirror.net/):** A code editor component.
- **[Pyodide](https://pyodide.org/):** A Python distribution for the browser
based on [WebAssembly](https://webassembly.org/), integrated through
[Polyscript](https://pyscript.github.io/polyscript/).
- **[SQLite WASM](https://sqlite.org/wasm/):** A build of
[SQLite](https://sqlite.org/) to [WebAssembly](https://webassembly.org/) 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!

## Navigation

```{toctree}
:maxdepth: 1
Expand Down
8 changes: 7 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,20 @@ license = "MIT"
# license-files = ["LICENSE.txt", "LICENSES.deps.txt"]
keywords = []
classifiers = [
"Development Status :: 3 - Alpha",
"Development Status :: 4 - Beta",
"Framework :: Sphinx :: Extension",
"Framework :: Sphinx :: Theme",
"Intended Audience :: Developers",
"Intended Audience :: Education",
"License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
"Programming Language :: JavaScript",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3 :: Only",
"Programming Language :: SQL",
"Topic :: Documentation :: Sphinx",
"Topic :: Education",
"Topic :: Internet :: Site Management",
]
requires-python = ">=3.12"
dependencies = [
Expand Down
12 changes: 10 additions & 2 deletions tdoc/common/static/tdoc/styles.css.jinja
Original file line number Diff line number Diff line change
@@ -1,10 +1,18 @@
/* Copyright 2024 Remy Blank <remy@c-space.org> */
/* SPDX-License-Identifier: MIT */

:not(#_).hidden {
.hidden:not(#¶) {
display: none;
}
:not(#_).line-height-normal .highlight pre {
section.hidden-heading:not(#¶) > h1:first-child,
section.hidden-heading:not(#¶) > h2:first-child,
section.hidden-heading:not(#¶) > h3:first-child,
section.hidden-heading:not(#¶) > h4:first-child,
section.hidden-heading:not(#¶) > h5:first-child,
section.hidden-heading:not(#¶) > h6:first-child {
display: none;
}
.line-height-normal:not(#¶) .highlight pre {
line-height: normal;
}

Expand Down

0 comments on commit 6ff80d4

Please sign in to comment.