Merge pull request #26 from SpeysideHEP/doc

Update documentation

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 Jack Y. Araz
+Copyright (c) 2024 Jack Y. Araz
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

docs/_static/css/custom.css

@@ -1,15 +1,48 @@
-.wy-side-nav-search {
-    background-color: #343131;
+span#release {
+    font-size: x-small;
 }
 
-.wy-nav-content {
-    max-width: 1000px !important;
+.main-container {
+    position: relative;
+    margin-left: auto;
+    margin-right: auto;
+    margin-top: 50px;
+    margin-bottom: 10px;
 }
 
-.wy-table-responsive table td {
-    white-space: normal !important;
+.table-container {
+    font-size: 18px;
+    width: 100%;
+    margin-top: 30px;
+    margin-bottom: 30px;
+    background-color: rgba(128, 128, 128, 0.1);
 }
 
-.wy-table-responsive {
-    overflow: visible !important;
+.map-container {
+    height: 250px;
+    margin-left: auto;
+    margin-right: auto;
+    margin-top: 20px;
+    margin-bottom: 20px;
+    padding: 20px;
+}
+
+.key-container {
+    font-size: 16px;
+}
+
+.key-cell {
+    font-size: 16px;
+    line-height: 22px;
+    vertical-align: top;
+    width: 200px;
+    color: rgba(128, 128, 128, 1);
+    align-items: top;
+}
+
+.val-cell {
+    font-size: 16px;
+    width: 200px;
+    margin-right: 50px;
+    line-height: 22px;
 }

docs/conf.py

@@ -13,12 +13,14 @@
 sys.path.insert(0, str(Path("./ext").resolve()))
 
 project = "spey"
-copyright = "2023, Jack Y. Araz"
+copyright = "2024, Jack Y. Araz"
 author = "Jack Y. Araz"
 release = get_distribution("spey").version
 version = ".".join(release.split(".")[:3])
 language = "en"
 
+html_title = f'Spey <span id="release">v{release}</span>'
+
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
@@ -45,7 +47,7 @@
 ]
 
 # set the width of the page
-sphinx_rtd_size_width = "75%"
+sphinx_rtd_size_width = "100%"
 
 # external links
 xref_links = {
@@ -92,7 +94,7 @@
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = "sphinx_rtd_theme"
+html_theme = "furo"
 html_static_path = ["_static"]
 html_css_files = ["css/custom.css"]
 

docs/requirements.txt

@@ -8,3 +8,4 @@ sphinx-copybutton>=0.3.2
 sphinx-togglebutton>=0.3.0
 myst-parser
 sphinx-rtd-size
+furo