aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/docs/source
diff options
context:
space:
mode:
authorHsiangNianian <i@jyunko.cn>2025-10-07 03:02:45 +0800
committerHsiangNianian <i@jyunko.cn>2025-10-07 03:02:45 +0800
commit2525e8916570951a3aceaf9e922c8c1408ca101c (patch)
tree656d21ad77b58e81dafba40418f8b7943197e4ce /docs/source
parenteed79104079647ddca2ebde5e585d22d7ba9854d (diff)
downloadOneRoll-2525e8916570951a3aceaf9e922c8c1408ca101c.tar.gz
OneRoll-2525e8916570951a3aceaf9e922c8c1408ca101c.zip
feat: enhance documentation build process with rinoh support and update dependencies
Diffstat (limited to 'docs/source')
-rw-r--r--docs/source/conf.py22
-rw-r--r--docs/source/index.rst6
2 files changed, 27 insertions, 1 deletions
diff --git a/docs/source/conf.py b/docs/source/conf.py
index b156ee0..72a569b 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -4,6 +4,26 @@
# https://www.sphinx-doc.org/en/master/usage/configuration.html
import os, sys
+from pathlib import Path
+
+# from rinoh.frontend.rst import ReStructuredTextReader
+# from rinoh.template import TemplateConfigurationFile
+
+# the parser builds a rinohtype document tree
+# parser = ReStructuredTextReader()
+# with open('index.rst') as file:
+# document_tree = parser.parse(file)
+
+# load the article template configuration file
+# script_path = Path(sys.path[0]).resolve()
+# config = TemplateConfigurationFile(script_path / 'oneroll.rtt')
+
+# render the document to 'my_document.pdf'
+# document = config.document(document_tree)
+# document.render('my_document')
+
+# rinoh_documents = [dict(doc='index', # top-level file (index.rst)
+# target='manual')] # output file (manual.pdf)
if sys.version_info >= (3, 11):
import tomllib
@@ -55,6 +75,7 @@ extensions = [
"sphinxcontrib.httpdomain",
"sphinx.ext.ifconfig",
"myst_parser",
+ "sphinx_click",
]
doctest_global_setup = """
@@ -149,3 +170,4 @@ html_theme_options = {
# '**': ['globaltoc.html', 'sourcelink.html', 'searchbox.html', 'relations.html'],
# 'using/windows': ['windowssidebar.html', 'searchbox.html'],
# }
+latex_documents = {}
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 0a5fff9..b3610c4 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -8,4 +8,8 @@ OneRoll
introduction
usage
api
- examples \ No newline at end of file
+ examples
+
+
+Indices and tables
+================== \ No newline at end of file