mirror of
https://github.com/agentscope-ai/ReMe.git
synced 2026-08-28 05:25:04 +00:00
132 lines
No EOL
4.2 KiB
YAML
132 lines
No EOL
4.2 KiB
YAML
# Book settings
|
|
# Learn more at https://jupyterbook.org/customize/config.html
|
|
|
|
project: "ReMe"
|
|
title: "<div style='text-align:center'>
|
|
<span style='font-weight:700;color:#2196f3;'>AgentScope</span><br>
|
|
<span style='font-weight:900;color:#ff5722;'>ReMe</span>
|
|
</div>"
|
|
author: Alibaba Tongyi Lab
|
|
logo: _static/figure/logo.svg
|
|
copyright: "2025, Tongyi Lab, Alibaba Inc."
|
|
only_build_toc_files: true
|
|
|
|
# Force re-execution of notebooks on each build.
|
|
# See https://jupyterbook.org/content/execute.html
|
|
execute:
|
|
execute_notebooks: off
|
|
|
|
parse:
|
|
myst_enable_extensions:
|
|
- colon_fence
|
|
- deflist
|
|
- attrs_inline
|
|
- dollarmath
|
|
|
|
# Define the name of the latex output file for PDF builds
|
|
latex:
|
|
latex_documents:
|
|
targetname: book.tex
|
|
|
|
# Add a bibtex file so that we can create citations
|
|
bibtex_bibfiles:
|
|
- references.bib
|
|
|
|
html:
|
|
extra_js:
|
|
- _static/memory-lib/memory-lib.js
|
|
extra_css:
|
|
- _static/memory-lib/memory-lib.css
|
|
- _static/custom.css
|
|
|
|
# Sphinx settings
|
|
sphinx:
|
|
extra_extensions:
|
|
- sphinx.ext.autodoc
|
|
- sphinx.ext.viewcode
|
|
- sphinx.ext.napoleon
|
|
- sphinx.ext.intersphinx
|
|
- sphinx.ext.autosummary
|
|
- sphinxcontrib.mermaid
|
|
- sphinx_design
|
|
config:
|
|
# API Documentation Configuration
|
|
autosummary_generate: True
|
|
autosummary_imported_members: True
|
|
|
|
# Autodoc Configuration
|
|
autodoc_typehints: 'description'
|
|
autodoc_member_order: 'bysource'
|
|
autodoc_default_options:
|
|
members: True
|
|
member-order: 'bysource'
|
|
special-members: '__init__'
|
|
undoc-members: True
|
|
exclude-members: '__weakref__'
|
|
|
|
# Napoleon Configuration
|
|
napoleon_google_docstring: True
|
|
napoleon_numpy_docstring: True
|
|
napoleon_include_init_with_doc: False
|
|
napoleon_include_private_with_doc: False
|
|
napoleon_include_special_with_doc: True
|
|
napoleon_use_admonition_for_examples: False
|
|
napoleon_use_admonition_for_notes: False
|
|
napoleon_use_admonition_for_references: False
|
|
napoleon_use_ivar: False
|
|
napoleon_use_param: True
|
|
napoleon_use_rtype: True
|
|
|
|
# Intersphinx Configuration
|
|
intersphinx_mapping:
|
|
python: ['https://docs.python.org/3', null]
|
|
numpy: ['https://numpy.org/doc/stable/', null]
|
|
|
|
# Theme Configuration
|
|
html_theme: furo
|
|
pygments_style: "friendly"
|
|
html_show_sphinx: false
|
|
html_last_updated_fmt: "%Y-%m-%d"
|
|
html_copy_source: false
|
|
html_show_sourcelink: false
|
|
templates_path: ["./_templates"]
|
|
html_static_path:
|
|
- "_static"
|
|
use_multitoc_numbering: false
|
|
html_js_files:
|
|
- language.js
|
|
html_css_files:
|
|
- custom.css
|
|
html_sidebars:
|
|
"**":
|
|
- "sidebar/scroll-start.html"
|
|
- "sidebar/brand.html"
|
|
- "sidebar/search.html"
|
|
- "sidebar/navigation.html"
|
|
- "sidebar/ethical-ads.html"
|
|
- "sidebar/scroll-end.html"
|
|
html_theme_options:
|
|
top_of_page_buttons: ["view"]
|
|
sidebar_hide_name: false
|
|
source_repository: "https://reme.agentscope.io"
|
|
source_branch: "main"
|
|
source_directory: "docs/"
|
|
footer_icons:
|
|
- name: GitHub
|
|
url: "https://reme.agentscope.io"
|
|
html: |
|
|
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16">
|
|
<path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path>
|
|
</svg>
|
|
class: ""
|
|
light_css_variables:
|
|
color-brand-primary: "#2196f3"
|
|
color-brand-content: "#2196f3"
|
|
color-admonition-background: "#f8f9fa"
|
|
dark_css_variables:
|
|
color-brand-primary: "#64b5f6"
|
|
color-brand-content: "#64b5f6"
|
|
|
|
# jupyter-book build --all .
|
|
# echo "reme.agentscope.io" > _build/html/CNAME
|
|
# ghp-import -n -p -f _build/html |