sphinx:doc

Author: miaobyte

doc/conf.py

@@ -7,26 +7,67 @@
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
 project = 'DeepX'
-copyright = '2025, YourName'
-author = 'YourName'
+copyright = '2025, DeepX Team'
+author = 'DeepX Team'
 
-version = '1.0'
-release = '0.1'
+version = '0.1.0'
+release = '0.1.0-alpha'
 
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
 extensions = [
     'sphinx_rtd_theme',
+    'sphinx.ext.autodoc',
+    'sphinx.ext.napoleon',
+    'sphinx.ext.viewcode',
+    'myst_parser'
 ]
 
+source_suffix = {
+    '.rst': 'restructuredtext',
+    '.md': 'markdown',
+}
+
 templates_path = ['_templates']
-exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+exclude_patterns = [
+    '_build', 
+    'Thumbs.db', 
+    '.DS_Store',
+    'README.md',
+    'node_modules'
+]
 
-language = 'zn'
+# 多语言支持
+language = 'zh_CN'
+locale_dirs = ['locale/']
+gettext_compact = False
 
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = 'alabaster'
-html_static_path = ['_static']
+html_theme = 'sphinx_rtd_theme'
+html_static_path = ['_static']
+html_theme_options = {
+    'logo_only': True,
+    'display_version': True,
+    'style_nav_header_background': '#2B2D42',
+}
+
+html_css_files = [
+    'css/custom.css',
+]
+
+html_js_files = [
+    'js/custom.js',
+]
+
+# 自定义扩展配置
+autodoc_member_order = 'bysource'
+napoleon_include_init_with_doc = True
+myst_enable_extensions = [
+    "colon_fence",
+    "deflist",
+    "dollarmath",
+    "html_image",
+]

doc/index.rst

@@ -3,8 +3,40 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-DeepX documentation
-===================
+DeepX 开放计算调度框架
+======================
+
+.. toctree::
+   :maxdepth: 3
+   :caption: 核心文档
+   
+   introduction
+   architecture
+   quickstart
+   modules
+   api_reference
+   development_guide
+
+.. toctree::
+   :maxdepth: 2
+   :caption: 开发者资源
+   
+   contrib/operator_development
+   contrib/performance_optimization
+   contrib/testing_guide
+
+.. toctree::
+   :maxdepth: 1
+   :caption: 项目信息
+   
+   changelog
+   about
+
+索引和搜索
+==========
+
+* :ref:`genindex`
+* :ref:`search`
 
 Add your content using ``reStructuredText`` syntax. See the
 `reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_