aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/docs/source
diff options
context:
space:
mode:
author简律纯 <i@jyunko.cn>2024-05-28 00:28:39 +0800
committer简律纯 <i@jyunko.cn>2024-05-28 00:28:39 +0800
commit28a7b2ecd90e7e67427682a99b8616e13042b4ab (patch)
treeb97c4784f5b27963aafde21701a135934fef6f5d /docs/source
parent2c8f4880eb6ddd0040c20e264dac1aebb018a8b2 (diff)
downloadHydroRollCore-28a7b2ecd90e7e67427682a99b8616e13042b4ab.tar.gz
HydroRollCore-28a7b2ecd90e7e67427682a99b8616e13042b4ab.zip
chore: refresh source tree files
Diffstat (limited to 'docs/source')
-rw-r--r--docs/source/conf.py10
-rw-r--r--docs/source/index.rst2
-rw-r--r--docs/source/pages/quick-start.rst2
3 files changed, 6 insertions, 8 deletions
diff --git a/docs/source/conf.py b/docs/source/conf.py
index 602956e..c423830 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -23,7 +23,7 @@ AUTHORS = ",".join([f"{aut}" for aut in AUTHOR_TABLE])
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
-project = PROJECT_NAME # "Infini"
+project = PROJECT_NAME # "HydroRollCore"
release = PROJECT_VERSION # "latest"
copyright = "2023-PRESENT, HydroRoll-Team."
author = AUTHORS # "Hsiang Nianian"
@@ -64,9 +64,7 @@ gettext_uuid = True # optional.
html_theme = "furo"
html_static_path = ["../_static"]
-_html_logo = (
- "https://cdn.jsdelivr.net/gh/HydroRoll-Team/HydroRollCore@main/docs/_static/logo.png"
-)
+_html_logo = "https://cdn.jsdelivr.net/gh/HydroRoll-Team/HydroRollCore@main/docs/_static/logo.png"
html_favicon = _html_logo
html_css_files = [
@@ -75,7 +73,7 @@ html_css_files = [
]
html_theme_options = {
- "announcement": "<em><a href='#'>documentation</a> is still under construction now, welcome any <a href='contributing.html'>contribution</a>!</em>",
+ "announcement": "🎉 <em><a href='#'>documentation</a> is still under construction now, welcome any <a href='contributing.html'>contribution</a>!</em>",
"source_repository": "https://github.com/HydroRoll-Team/HydroRollCore/",
"source_branch": "main",
"source_directory": "docs/source/",
@@ -88,7 +86,7 @@ html_theme_options = {
},
{
"name": "Pypi",
- "url": "https://pypi.org/project/hydro_roll_core/",
+ "url": "https://pypi.org/project/hydroroll-core/",
"html": "",
"class": "fa-brands fa-python",
},
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 3b2f020..efda5f6 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -1,6 +1,6 @@
.. hide-toc: true
-Nivis - ❄
+HydroRollCore
=========
.. include:: ../../README.rst
diff --git a/docs/source/pages/quick-start.rst b/docs/source/pages/quick-start.rst
index 61ba1ad..863ae58 100644
--- a/docs/source/pages/quick-start.rst
+++ b/docs/source/pages/quick-start.rst
@@ -1,3 +1,3 @@
-Welcome to the nivis!
+Welcome to the Core!
=====================