From 28a7b2ecd90e7e67427682a99b8616e13042b4ab Mon Sep 17 00:00:00 2001 From: 简律纯 Date: Tue, 28 May 2024 00:28:39 +0800 Subject: chore: refresh source tree files --- docs/Makefile | 2 +- docs/source/conf.py | 10 ++++------ docs/source/index.rst | 2 +- docs/source/pages/quick-start.rst | 2 +- 4 files changed, 7 insertions(+), 9 deletions(-) (limited to 'docs') diff --git a/docs/Makefile b/docs/Makefile index fc24907..6fdb78c 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -5,7 +5,7 @@ # from the environment for the first two. SPHINXOPTS ?= SPHINXBUILD ?= sphinx-build -SOURCEDIR = . +SOURCEDIR = source BUILDDIR = _build SPHINXINTL ?= sphinx-intl lang ?= zh_CN 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": "documentation is still under construction now, welcome any contribution!", + "announcement": "🎉 documentation is still under construction now, welcome any contribution!", "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! ===================== -- cgit v1.2.3-70-g09d2