Skip to content

Commit 0e08ccc

Browse files
committed
sphinx:doc
1 parent cf6e1ad commit 0e08ccc

3 files changed

Lines changed: 55 additions & 0 deletions

File tree

doc/.gitignore

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
.DS_Store
2+
.venv
3+
_build
4+
make.bat
5+
Makefile
6+
_static
7+
_templates

doc/conf.py

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Configuration file for the Sphinx documentation builder.
2+
#
3+
# For the full list of built-in configuration values, see the documentation:
4+
# https://www.sphinx-doc.org/en/master/usage/configuration.html
5+
6+
# -- Project information -----------------------------------------------------
7+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
8+
9+
project = 'DeepX'
10+
copyright = '2025, YourName'
11+
author = 'YourName'
12+
13+
version = '1.0'
14+
release = '0.1'
15+
16+
# -- General configuration ---------------------------------------------------
17+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
18+
19+
extensions = [
20+
'sphinx_rtd_theme',
21+
]
22+
23+
templates_path = ['_templates']
24+
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
25+
26+
language = 'zn'
27+
28+
# -- Options for HTML output -------------------------------------------------
29+
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
30+
31+
html_theme = 'alabaster'
32+
html_static_path = ['_static']

doc/index.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
.. DeepX documentation master file, created by
2+
sphinx-quickstart on Tue Mar 4 12:21:01 2025.
3+
You can adapt this file completely to your liking, but it should at least
4+
contain the root `toctree` directive.
5+
6+
DeepX documentation
7+
===================
8+
9+
Add your content using ``reStructuredText`` syntax. See the
10+
`reStructuredText <https://www.sphinx-doc.org/en/master/usage/restructuredtext/index.html>`_
11+
documentation for details.
12+
13+
14+
.. toctree::
15+
:maxdepth: 2
16+
:caption: Contents:

0 commit comments

Comments
 (0)