added image

ggangliu · Apr 4, 2024 · 29f8690 · 29f8690
1 parent b3db1e8
commit 29f8690
Show file tree

Hide file tree

Showing 5 changed files with 33 additions and 9 deletions.
diff --git a/docs/images/first-riscv-cpu-arch.png b/docs/images/first-riscv-cpu-arch.png
diff --git a/docs/images/riscv-playground-cpu-arch.png b/docs/images/riscv-playground-cpu-arch.png
diff --git a/docs/source/_static/first-riscv-cpu-arch.png b/docs/source/_static/first-riscv-cpu-arch.png
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -5,11 +5,16 @@
 
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+import os
+import sys
+import sphinx
+import datetime
 
 project = 'first-riscv'
 copyright = '2024, ggangliu'
 author = 'ggangliu'
 release = '0.01'
+version = "0.01"
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
@@ -27,18 +32,34 @@
 html_theme = 'sphinx_rtd_theme' #'alabaster'
 html_static_path = ['_static']
 
+html_css_files = ['_variables.scss']
+
+
+
 simplepdf_vars = {
-    'primary': '#FA2323',
+    'cover-overlay': 'rgba(26, 150, 26, 0.7)',
+    'primary-opaque': 'rgba(26, 150, 26, 0.7)',
+    'cover-bg': 'url(cover-bg.jpg) no-repeat center',
+    'primary': '#1a961a',
     'secondary': '#379683',
     'cover': '#ffffff',
     'white': '#ffffff',
-    'links': 'FA2323',
-    'cover-bg': 'url(cover-bg.jpg) no-repeat center',
-    'cover-overlay': 'rgba(250, 35, 35, 0.5)',
-    'top-left-content': 'counter(page)',
-    'bottom-center-content': '"Custom footer content"',
+    'links': '#1a961a',
+    'top-left-content': '"Header left"',
+    'top-center-content': '"Header center"',
+    'top-right-content': '"Header right"',
+    'bottom-left-content': 'counter(page)',
+    'bottom-center-content': '"first RISC-V"',
+    'bottom-right-content': 'string(heading)',
+}
+
+source_suffix = {
+    '.rst': 'restructuredtext',
+    '.txt': 'restructuredtext',
+    '.md': 'markdown',
 }
 
+
 # conf.py
 extensions = ['sphinx_simplepdf', 'rst2pdf.pdfbuilder']
 pdf_documents = [('index', u'rst2pdf', u'Sample rst2pdf doc', u'ggangliu'),]
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -6,6 +6,7 @@
 Welcome to first-riscv's documentation!
 =======================================
 
+.. image:: _static/first-riscv-cpu-arch.png
 
 Site Index
 ==========
@@ -22,6 +23,8 @@ Site Index
 Indices and tables
 ==================
 
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+.. note::
+
+	* :ref:`genindex`
+	* :ref:`modindex`
+	* :ref:`search`