diff options
| author |   HsiangNianian <i@jyunko.cn> | 2025-10-06 00:56:22 +0800 |
|---|---|---|
| committer | HsiangNianian <i@jyunko.cn> | 2025-10-06 00:56:22 +0800 |
| commit | 8e6fdbf4cf68185ab9318637af0c40cdb5f66b48 (patch) | |
| tree | 3ca3f148fcdce50d1ac8a5cfb8523b7e59103ec7 /docs/source | |
| parent | 3649653bde885371833a33e7265a3b3e76852122 (diff) | |
| download | OneRoll-8e6fdbf4cf68185ab9318637af0c40cdb5f66b48.tar.gz OneRoll-8e6fdbf4cf68185ab9318637af0c40cdb5f66b48.zip | |
feat: add Sphinx configuration and index file for documentation setup
Diffstat (limited to 'docs/source')
| -rw-r--r-- | docs/source/conf.py (renamed from docs/source/config.py) | 14 | ||||
| -rw-r--r-- | docs/source/index.rst | 11 |
2 files changed, 18 insertions, 7 deletions
diff --git a/docs/source/config.py b/docs/source/conf.py index 83c0158..b156ee0 100644 --- a/docs/source/config.py +++ b/docs/source/conf.py @@ -28,7 +28,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 = "HydroRoll" # PROJECT_NAME +project = "OneRoll" # PROJECT_NAME release = PROJECT_VERSION # "latest" copyright = "2023-PRESENT, HydroRoll-Team." author = AUTHORS # "Hsiang Nianian" @@ -89,15 +89,15 @@ rst_prolog = """ rst_epilog = """ .. |psf| replace:: Python Software Foundation """ -locale_dirs = ["../locales/"] # path is example but recommended. -gettext_compact = False # optional. -gettext_uuid = True # optional. +# locale_dirs = ["../locales/"] # path is example but recommended. +# gettext_compact = False # optional. +# gettext_uuid = True # optional. numfig = True # Figures, tables and code blocks are automatically numbered if they have a title pygments_style = "rrt" # default sphinx, change the style of code block math_number_all = True # Number all equations, figures, tables and code blocks -html_additional_pages = { - "copy": "copying.html", -} +# html_additional_pages = { +# "copy": "copying.html", +# } html_split_index = True # Split the index page by each alphabet # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output diff --git a/docs/source/index.rst b/docs/source/index.rst index e69de29..0a5fff9 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -0,0 +1,11 @@ +OneRoll +======= + +.. toctree:: + :maxdepth: 2 + :caption: Contents + + introduction + usage + api + examples
\ No newline at end of file |