mirror of
https://github.com/volcengine/verl.git
synced 2025-10-20 21:53:50 +08:00
bcd336fd46
## Summary This PR adds a resizable sidebar feature and improves the documentation layout for better user experience. ## Changes - **Resizable sidebar**: Users can drag to resize the sidebar, with preference saved in localStorage - **Full-width layout**: Documentation now uses full screen width for better readability - **Responsive design**: Better layout adaptation for different screen sizes - **Navigation improvements**: Attempts to improve table of contents navigation behavior ## Features - Drag handle on sidebar for resizing - Double-click to reset sidebar to default width - localStorage persistence for user preferences - Improved CSS for better visual experience ## Technical Details - Added `_static/custom.css` for styling improvements - Added `_static/js/resizable-sidebar.js` for functionality - Updated `conf.py` to include new CSS and JS files ## Testing Tested on the documentation build with successful functionality for sidebar resizing and layout improvements.
107 lines
3.6 KiB
Python
107 lines
3.6 KiB
Python
# Copyright 2024 Bytedance Ltd. and/or its affiliates
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
# Configuration file for the Sphinx documentation builder.
|
|
#
|
|
# This file only contains a selection of the most common options. For a full
|
|
# list see the documentation:
|
|
# https://www.sphinx-doc.org/en/master/usage/configuration.html
|
|
|
|
# -- Path setup --------------------------------------------------------------
|
|
|
|
# If extensions (or modules to document with autodoc) are in another directory,
|
|
# add these directories to sys.path here. If the directory is relative to the
|
|
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
|
#
|
|
# import os
|
|
# import sys
|
|
# sys.path.insert(0, os.path.abspath('.'))
|
|
|
|
|
|
# -- Project information -----------------------------------------------------
|
|
|
|
project = "verl"
|
|
copyright = "2024 ByteDance Seed Foundation MLSys Team"
|
|
author = "Guangming Sheng, Chi Zhang, Yanghua Peng, Haibin Lin"
|
|
|
|
|
|
# -- General configuration ---------------------------------------------------
|
|
# The master toctree document.
|
|
master_doc = "index"
|
|
|
|
# Add any Sphinx extension module names here, as strings. They can be
|
|
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
|
# ones.
|
|
extensions = [
|
|
"myst_parser",
|
|
"sphinx.ext.autodoc",
|
|
"sphinx.ext.autosummary",
|
|
"sphinx.ext.autosectionlabel",
|
|
"sphinx.ext.napoleon",
|
|
"sphinx.ext.viewcode",
|
|
]
|
|
# Use Google style docstrings instead of NumPy docstrings.
|
|
napoleon_google_docstring = True
|
|
napoleon_numpy_docstring = False
|
|
|
|
# The suffix(es) of source filenames.
|
|
# You can specify multiple suffix as a list of string:
|
|
source_suffix = {
|
|
".rst": "restructuredtext",
|
|
".md": "markdown",
|
|
}
|
|
|
|
# Add any paths that contain templates here, relative to this directory.
|
|
templates_path = ["_templates"]
|
|
|
|
# The language for content autogenerated by Sphinx. Refer to documentation
|
|
# for a list of supported languages.
|
|
#
|
|
# This is also used if you do content translation via gettext catalogs.
|
|
# Usually you set "language" from the command line for these cases.
|
|
language = "en"
|
|
|
|
# List of patterns, relative to source directory, that match files and
|
|
# directories to ignore when looking for source files.
|
|
# This pattern also affects html_static_path and html_extra_path.
|
|
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
|
|
|
|
|
|
# -- Options for HTML output -------------------------------------------------
|
|
|
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
|
# a list of builtin themes.
|
|
#
|
|
html_theme = "sphinx_rtd_theme"
|
|
|
|
# Add any paths that contain custom static files (such as style sheets) here,
|
|
# relative to this directory. They are copied after the builtin static files,
|
|
# so a file named "default.css" will overwrite the builtin "default.css".
|
|
html_static_path = ["_static"]
|
|
|
|
# Add the JavaScript file
|
|
html_js_files = [
|
|
"js/runllm-widget.js",
|
|
"js/resizable-sidebar.js",
|
|
]
|
|
|
|
# Add custom CSS file for full-width layout
|
|
html_css_files = [
|
|
"custom.css",
|
|
]
|
|
|
|
exclude_patterns += ["README.md", "README_vllm0.7.md"]
|
|
|
|
suppress_warnings = ["ref.duplicate", "ref.myst"]
|