create_docs_framework (#66)

* Init from quick start

* optimize docs config

* add image

* optimize docs config

* complement file

* drop comments

* add ci

---------

Co-authored-by: Young <afe.young@gmail.com>

.github/workflows/ci.yml

@@ -29,7 +29,7 @@ jobs:
           EMBEDDING_AZURE_API_VERSION: ${{ secrets.CHAT_AZURE_API_VERSION }}
           EMBEDDING_MODEL: ${{ secrets.EMBEDDING_MODEL }}
         name: lint test docs and build
-        run: make lint test docs build
+        run: make lint test docs build sphinx
     strategy:
       matrix:
         python-version:

Makefile

@@ -83,6 +83,11 @@ constraints: deepclean
 black:
 	$(PIPRUN) python -m black --check . --extend-exclude test/scripts --extend-exclude git_ignore_folder -l 120
 
+sphinx:
+	cd docs
+	$(PIPRUN) sphinx-build -W --keep-going -b html . _build
+	cd ..
+
 # Check lint with isort.
 isort:
 	$(PIPRUN) python -m isort --check . -s git_ignore_folder -s test/scripts

README.md

@@ -32,7 +32,7 @@ In this project, we are aiming to build a Data-Centric R\&D Agent that can
 
 + Further propose new ideas based on current knowledge and observations.
 
-![Data-Centric R&D Overview](docs/images/overview.png)
+![Data-Centric R&D Overview](docs/_static/overview.png)
 
 ### 🛣️ Brief Roadmap
 In this section, we will briefly introduce the roadmap/technical type of this project.

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)

docs/api_reference.rst

@@ -0,0 +1,18 @@
+=========================
+API reference
+=========================
+
+title1
+=========================
+
+content1
+
+title2
+=========================
+
+content2
+
+title3
+=========================
+
+content3

docs/conf.py

@@ -0,0 +1,62 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+import importlib.metadata
+
+project = 'RDAgent'
+copyright = '2024, Microsoft'
+author = 'Microsoft'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = []
+
+autodoc_member_order = "bysource"
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+source_encoding = 'utf-8'
+
+# The main toctree document.
+master_doc = 'index'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = importlib.metadata.version("rdagent")
+release = importlib.metadata.version("rdagent")
+
+# The language for content autogenerated by Sphinx. Refer to documentation for
+# a list of supported languages.
+language = "en"
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = ['build']
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+try:
+    import furo
+
+    html_theme = 'furo'
+    html_theme_options = {
+        "navigation_with_keys": True,
+    }
+except ImportError:
+    html_theme = 'default'
+
+html_static_path = ['_static']

docs/demo_and_introduction.rst

@@ -0,0 +1,18 @@
+=========================
+Demo and Introduction
+=========================
+
+title1
+=========================
+
+content1
+
+title2
+=========================
+
+content2
+
+title3
+=========================
+
+content3

docs/development.rst

@@ -0,0 +1,18 @@
+=========================
+For Development
+=========================
+
+title1
+=========================
+
+content1
+
+title2
+=========================
+
+content2
+
+title3
+=========================
+
+content3

docs/index.rst

@@ -0,0 +1,27 @@
+.. RDAgent documentation master file, created by
+   sphinx-quickstart on Mon Jul 15 04:27:50 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to RDAgent's documentation!
+===================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Doctree:
+
+   installation
+   development
+   api_reference
+   demo_and_introduction
+   project_framework_introduction
+   scenarios_and_quickstart
+   test_dropdown/test1
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/installation.rst

@@ -0,0 +1,18 @@
+=========================
+Installation
+=========================
+
+title1
+=========================
+
+content1
+
+title2
+=========================
+
+content2
+
+title3
+=========================
+
+content3

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
+
+%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.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/project_framework_introduction.rst

@@ -0,0 +1,18 @@
+===============================
+Project framework introduction
+===============================
+
+title1
+=========================
+
+content1
+
+title2
+=========================
+
+content2
+
+title3
+=========================
+
+content3

docs/requirements.txt

@@ -0,0 +1,4 @@
+sphinx
+sphinx_rtd_theme
+furo
+importlib.metadata

docs/scenarios_and_quickstart.rst

@@ -0,0 +1,18 @@
+=========================
+Scenarios and Quick Start
+=========================
+
+title1
+=========================
+
+content1
+
+title2
+=========================
+
+content2
+
+title3
+=========================
+
+content3

docs/test_dropdown/test1.rst

@@ -0,0 +1,28 @@
+=========================
+Test dropdown 1
+=========================
+
+title1
+=========================
+
+content1
+
+title2
+=========================
+
+content2
+
+title3
+=========================
+
+content3
+
+
+
+
+.. toctree::
+   :maxdepth: 1
+   :caption: Doctree:
+   :hidden:
+
+   test2

docs/test_dropdown/test2.rst

@@ -0,0 +1,18 @@
+=========================
+Test dropdown 2
+=========================
+
+title1
+=========================
+
+content1
+
+title2
+=========================
+
+content2
+
+title3
+=========================
+
+content3