From 0d0705a1694bfa057c1f84ee7c683a3653a9160f Mon Sep 17 00:00:00 2001 From: longjin Date: Fri, 17 Jun 2022 23:50:40 +0800 Subject: [PATCH] =?UTF-8?q?=E5=88=9D=E5=A7=8B=E5=8C=96=E4=BA=86=E6=96=87?= =?UTF-8?q?=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .gitignore | 4 ++- docs/Makefile | 20 +++++++++++++ docs/conf.py | 61 ++++++++++++++++++++++++++++++++++++++ docs/index.rst | 39 ++++++++++++++++++++++++ docs/introduction/intro.md | 2 ++ docs/make.bat | 35 ++++++++++++++++++++++ docs/requirements.txt | 3 ++ docs/syscall_api/intro.md | 1 + 8 files changed, 164 insertions(+), 1 deletion(-) create mode 100644 docs/Makefile create mode 100644 docs/conf.py create mode 100644 docs/index.rst create mode 100644 docs/introduction/intro.md create mode 100644 docs/make.bat create mode 100644 docs/requirements.txt create mode 100644 docs/syscall_api/intro.md diff --git a/.gitignore b/.gitignore index 06548357..2fff4a67 100644 --- a/.gitignore +++ b/.gitignore @@ -7,4 +7,6 @@ kernel/kernel *.o *.s serial_opt.txt -user/sys_api_lib \ No newline at end of file +user/sys_api_lib + +docs/_build \ No newline at end of file diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 00000000..d4bb2cbb --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 00000000..0fd4e8da --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,61 @@ +# 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 = 'DragonOS' +copyright = '2022, fslongjin' +author = 'fslongjin' + +# The full version, including alpha/beta/rc tags +release = 'dev' + + +# -- General configuration --------------------------------------------------- + +# 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'] + +# 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 = 'zh_CN' + +# 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'] +source_suffix = ['.rst', '.md'] + +# -- 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'] \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 00000000..a372054c --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,39 @@ +.. DragonOS documentation master file, created by + sphinx-quickstart on Fri Jun 17 23:12:00 2022. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +欢迎来到DragonOS的文档！ +==================================== + +.. toctree:: + :maxdepth: 2 + :caption: 入门 + + introduction/intro + +.. toctree:: + :maxdepth: 2 + :caption: 内核层 + + introduction/intro + +.. toctree:: + :maxdepth: 2 + :caption: 用户层 + + introduction/intro + +.. toctree:: + :maxdepth: 2 + :caption: 系统调用api文档 + + syscall_api/intro + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/introduction/intro.md b/docs/introduction/intro.md new file mode 100644 index 00000000..163c2a07 --- /dev/null +++ b/docs/introduction/intro.md @@ -0,0 +1,2 @@ +# 简介 + diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 00000000..922152e9 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=. +set BUILDDIR=_build + +if "%1" == "" goto help + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000..03b37ebf --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,3 @@ +sphinx +myst-parser +sphinx-rtd-theme \ No newline at end of file diff --git a/docs/syscall_api/intro.md b/docs/syscall_api/intro.md new file mode 100644 index 00000000..4379f92b --- /dev/null +++ b/docs/syscall_api/intro.md @@ -0,0 +1 @@ +# 系统调用API文档 \ No newline at end of file