test/acl
1
0
Fork 0
mirror of https://gitee.com/acl-dev/acl.git synced 2024-11-29 10:27:39 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add doc for readthedocs.

Browse Source
This commit is contained in:
zhengshuxin 2023-12-01 14:30:45 +08:00
parent 962e8f80fd
commit c38c4cbccc
20 changed files with 947 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
.readthedocs.yaml Normal file
View File

@ -0,0 +1,13 @@
version: "2"
build:
os: "ubuntu-22.04"
tools:
python: "3.10"
python:
install:
- requirements: docs/requirements.txt
sphinx:
configuration: docs/source/conf.py

19
docs/Doxyfile Normal file
View File

@ -0,0 +1,19 @@
PROJECT_NAME = "Acl"
XML_OUTPUT = xml
INPUT = ../lib_acl_cpp/include/ \
../lib_protoco/include/ \
../lib_acl/include/
GENERATE_LATEX = NO
GENERATE_MAN = NO
GENERATE_RTF = NO
CASE_SENSE_NAMES = NO
GENERATE_HTML = NO
GENERATE_XML = YES
RECURSIVE = YES
QUIET = YES
JAVADOC_AUTOBRIEF = YES
WARN_IF_UNDOCUMENTED = NO
WARN_AS_ERROR = NO
ENABLE_PREPROCESSING = YES
MACRO_EXPANSION = YES
EXPAND_ONLY_PREDEF = YES

186
docs/Makefile Normal file
View File

@ -0,0 +1,186 @@
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = build
# User-friendly check for sphinx-build
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
endif
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext api
default: html
help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " applehelp to make an Apple Help Book"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " xml to make Docutils-native XML files"
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
@echo " coverage to run coverage check of the documentation (if enabled)"
clean:
rm -rf $(BUILDDIR)/*
html:
doxygen
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
dirhtml:
doxygen
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
singlehtml:
doxygen
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
pickle:
doxygen
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
json:
doxygen
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
htmlhelp:
doxygen
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
epub:
doxygen
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
latex:
doxygen
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
latexpdf:
doxygen
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
latexpdfja:
doxygen
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through platex and dvipdfmx..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
text:
doxygen
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
man:
doxygen
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
texinfo:
doxygen
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."
info:
doxygen
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
gettext:
doxygen
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
changes:
doxygen
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
linkcheck:
doxygen
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
doctest:
doxygen
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
coverage:
doxygen
$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
@echo "Testing of coverage in the sources finished, look at the " \
"results in $(BUILDDIR)/coverage/python.txt."
xml:
doxygen
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
@echo
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
pseudoxml:
doxygen
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
@echo
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

35
docs/make.bat Normal file
View File

@ -0,0 +1,35 @@
@ECHO OFF
pushd %~dp0
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=source
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

3
docs/requirements.txt Normal file
View File

@ -0,0 +1,3 @@
sphinx==7.1.2
sphinx-rtd-theme==1.3.0rc1
breathe==4.35.0

4
docs/source/_static/main_stylesheet.css Normal file
View File

@ -0,0 +1,4 @@
.wy-nav-content{
max-width: 1000px;
margin: auto;
}

23
docs/source/cn/install.rst Normal file
View File

@ -0,0 +1,23 @@
.. Copyright 2023 The Elastic AI Search Authors.
编译
====
.. image:: ../image/cmake.svg
build with cmake
系统依赖
---------------------------------
.. code-block::
apt install openssl
pip install carbin
EA Requirement
--------------------------------------------
Install
=======

13
docs/source/cn/overview.rst Normal file
View File

@ -0,0 +1,13 @@
.. Copyright 2023 The Elastic AI Search Authors.
总览
======
测试测试测试
特点
======
还是测试

37
docs/source/conf.py Normal file
View File

@ -0,0 +1,37 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
import os
import subprocess
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
if on_rtd:
subprocess.check_call('cd ..; doxygen', shell=True)
import sphinx_rtd_theme
html_theme = "sphinx_rtd_theme"
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
def setup(app):
app.add_css_file("main_stylesheet.css")
extensions = ['breathe']
breathe_projects = { 'acldocs': '../xml' }
templates_path = ['_templates']
html_static_path = ['_static']
source_suffix = '.rst'
master_doc = 'index'
project = 'acldocs'
copyright = 'Copyright 2023 The Acl Authors.'
author = 'zsxxsz'
#html_logo = 'image/ea_big.png'
exclude_patterns = []
highlight_language = 'c++'
pygments_style = 'sphinx'
todo_include_todos = False
htmlhelp_basename = 'acldocs'

11
docs/source/en/api/meta.rst Normal file
View File

@ -0,0 +1,11 @@
Meta Client Api
=========================
``MetaClient::check_config_file``
.. doxygengroup:: meta_client
:project: eadocs
:members:

23
docs/source/en/install.rst Normal file
View File

@ -0,0 +1,23 @@
.. Copyright 2023 The Elastic AI Search Authors.
Build
=====
.. image:: ../image/cmake.svg
build with cmake
System Dependencies
---------------------------------
.. code-block::
apt install openssl
pip install carbin
EA Requirement
-------------------------------------
Install
=======

8
docs/source/en/meta/atomic.rst Normal file
View File

@ -0,0 +1,8 @@
EA atomic
==========================
gen
----------------------------
update
------------------------

14
docs/source/en/meta/config.rst Normal file
View File

@ -0,0 +1,14 @@
EA config
===============================
config options
================================
create
--------------------------------
get
----------------------------------
list
-----------------------------------

4
docs/source/en/meta/introduction.rst Normal file
View File

@ -0,0 +1,4 @@
EA Meta Introduction
====================
EA meta service

8
docs/source/en/overview.rst Normal file
View File

@ -0,0 +1,8 @@
overview
========
goals
--------
asadada
----------

493
docs/source/image/cmake.svg Normal file
View File

@ -0,0 +1,493 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!-- Created with Inkscape (http://www.inkscape.org/) -->
<svg
xmlns:dc="http://purl.org/dc/elements/1.1/"
xmlns:cc="http://creativecommons.org/ns#"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns="http://www.w3.org/2000/svg"
xmlns:xlink="http://www.w3.org/1999/xlink"
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
id="svg2816"
version="1.1"
inkscape:version="0.47 r22583"
width="2072"
height="2072"
sodipodi:docname="Cmake.svg">
<metadata
id="metadata2822">
<rdf:RDF>
<cc:Work
rdf:about="">
<dc:format>image/svg+xml</dc:format>
<dc:type
rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
<dc:title />
</cc:Work>
</rdf:RDF>
</metadata>
<defs
id="defs2820">
<linearGradient
id="linearGradient4276">
<stop
style="stop-color:#32691d;stop-opacity:1"
offset="0"
id="stop4278" />
<stop
id="stop4280"
offset="0.02012207"
style="stop-color:#01d200;stop-opacity:0" />
<stop
style="stop-color:#ffffff;stop-opacity:0;"
offset="1"
id="stop4282" />
</linearGradient>
<linearGradient
id="linearGradient4227">
<stop
style="stop-color:#ebebec;stop-opacity:1"
offset="0"
id="stop4229" />
<stop
id="stop4231"
offset="0.00518292"
style="stop-color:#d3d3d3;stop-opacity:0" />
<stop
style="stop-color:#ffffff;stop-opacity:0;"
offset="1"
id="stop4233" />
</linearGradient>
<linearGradient
id="linearGradient4129">
<stop
id="stop4131"
offset="0"
style="stop-color:#cbf595;stop-opacity:1" />
<stop
style="stop-color:#01da00;stop-opacity:0"
offset="0.01826929"
id="stop4133" />
<stop
id="stop4135"
offset="1"
style="stop-color:#ffffff;stop-opacity:0;" />
</linearGradient>
<linearGradient
id="linearGradient4039">
<stop
style="stop-color:#321e1d;stop-opacity:1"
offset="0"
id="stop4041" />
<stop
id="stop4043"
offset="0.01546729"
style="stop-color:#555548;stop-opacity:0" />
<stop
style="stop-color:#ffffff;stop-opacity:0;"
offset="1"
id="stop4045" />
</linearGradient>
<linearGradient
id="linearGradient3990">
<stop
style="stop-color:#321e1d;stop-opacity:1"
offset="0"
id="stop3992" />
<stop
id="stop3994"
offset="0.02012207"
style="stop-color:#5a5bd7;stop-opacity:0" />
<stop
style="stop-color:#ffffff;stop-opacity:0;"
offset="1"
id="stop3996" />
</linearGradient>
<linearGradient
id="linearGradient3941">
<stop
id="stop3943"
offset="0"
style="stop-color:#f6b1b2;stop-opacity:1" />
<stop
style="stop-color:#c51f1f;stop-opacity:0"
offset="0.02821624"
id="stop3945" />
<stop
id="stop3947"
offset="1"
style="stop-color:#ffffff;stop-opacity:0;" />
</linearGradient>
<linearGradient
id="linearGradient3851">
<stop
id="stop3853"
offset="0"
style="stop-color:#321e1d;stop-opacity:1" />
<stop
style="stop-color:#555548;stop-opacity:0"
offset="0.02012207"
id="stop3855" />
<stop
id="stop3857"
offset="1"
style="stop-color:#ffffff;stop-opacity:0;" />
</linearGradient>
<linearGradient
id="linearGradient3800">
<stop
style="stop-color:#cbcaf2;stop-opacity:1"
offset="0"
id="stop3802" />
<stop
id="stop3808"
offset="0.02636753"
style="stop-color:#5555d2;stop-opacity:0" />
<stop
style="stop-color:#ffffff;stop-opacity:0;"
offset="1"
id="stop3804" />
</linearGradient>
<linearGradient
inkscape:collect="always"
id="linearGradient3715">
<stop
style="stop-color:#848484;stop-opacity:1"
offset="0"
id="stop3717" />
<stop
style="stop-color:#d2d2d2;stop-opacity:1"
offset="1"
id="stop3719" />
</linearGradient>
<linearGradient
inkscape:collect="always"
id="linearGradient3669">
<stop
style="stop-color:#01a300;stop-opacity:1"
offset="0"
id="stop3671" />
<stop
style="stop-color:#01df00;stop-opacity:1"
offset="1"
id="stop3673" />
</linearGradient>
<linearGradient
inkscape:collect="always"
id="linearGradient3653">
<stop
style="stop-color:#b40e0e;stop-opacity:1"
offset="0"
id="stop3655" />
<stop
style="stop-color:#ff5959;stop-opacity:1"
offset="1"
id="stop3657" />
</linearGradient>
<linearGradient
inkscape:collect="always"
id="linearGradient3645">
<stop
style="stop-color:#1011a1;stop-opacity:1"
offset="0"
id="stop3647" />
<stop
style="stop-color:#6969e1;stop-opacity:1"
offset="1"
id="stop3649" />
</linearGradient>
<linearGradient
inkscape:collect="always"
xlink:href="#linearGradient3645"
id="linearGradient3651"
x1="-1527.3507"
y1="1387.5206"
x2="-1086.1161"
y2="454.13968"
gradientUnits="userSpaceOnUse"
gradientTransform="translate(2104,48)" />
<linearGradient
inkscape:collect="always"
xlink:href="#linearGradient3653"
id="linearGradient3659"
x1="-933.38092"
y1="680.41388"
x2="-316.78384"
y2="1721.275"
gradientUnits="userSpaceOnUse"
gradientTransform="translate(2104,48)" />
<linearGradient
inkscape:collect="always"
xlink:href="#linearGradient3669"
id="linearGradient3675"
x1="-678.82251"
y1="1794.8141"
x2="-1549.978"
y2="1721.275"
gradientUnits="userSpaceOnUse"
gradientTransform="translate(2104,48)" />
<linearGradient
inkscape:collect="always"
xlink:href="#linearGradient3715"
id="linearGradient3721"
x1="-984.2926"
y1="1472.3735"
x2="-995.60632"
y2="1093.3643"
gradientUnits="userSpaceOnUse"
gradientTransform="translate(2104,48)" />
<filter
inkscape:collect="always"
id="filter3777">
<feGaussianBlur
inkscape:collect="always"
stdDeviation="9.0766588"
id="feGaussianBlur3779" />
</filter>
<linearGradient
inkscape:collect="always"
xlink:href="#linearGradient3800"
id="linearGradient3806"
x1="-1238.0465"
y1="919.71448"
x2="-555.82379"
y2="917.51282"
gradientUnits="userSpaceOnUse"
gradientTransform="matrix(1.9188939,0.98349385,-0.45611308,0.88992183,3476.0418,1285.266)" />
<linearGradient
y2="913.40582"
x2="-552.84039"
y1="919.71448"
x1="-1238.0465"
gradientTransform="matrix(-1.9407023,0.93972781,-0.43581582,-0.90003588,-412.21511,3168.6506)"
gradientUnits="userSpaceOnUse"
id="linearGradient3828"
xlink:href="#linearGradient3851"
inkscape:collect="always" />
<linearGradient
id="linearGradient3851-6">
<stop
id="stop3853-2"
offset="0"
style="stop-color:#321e1d;stop-opacity:1" />
<stop
style="stop-color:#555548;stop-opacity:0"
offset="0.02012207"
id="stop3855-4" />
<stop
id="stop3857-5"
offset="1"
style="stop-color:#ffffff;stop-opacity:0;" />
</linearGradient>
<linearGradient
y2="915.30005"
x2="-555.83728"
y1="919.71448"
x1="-1238.0465"
gradientTransform="matrix(0.02700295,-2.1560608,0.90368745,0.01314507,114.37039,-755.42907)"
gradientUnits="userSpaceOnUse"
id="linearGradient3877"
xlink:href="#linearGradient3851-6"
inkscape:collect="always" />
<linearGradient
y2="917.6181"
x2="-554.89746"
y1="919.71448"
x1="-1238.0465"
gradientTransform="matrix(3.1362513,0.00261809,0.06431073,0.7601511,4936.1356,68.133286)"
gradientUnits="userSpaceOnUse"
id="linearGradient3918"
xlink:href="#linearGradient3941"
inkscape:collect="always" />
<linearGradient
y2="917.51282"
x2="-555.82379"
y1="918.44379"
x1="-1229.327"
gradientTransform="matrix(-2.1510215,-0.07025797,-0.03821188,-0.48210687,-1498.469,1058.0104)"
gradientUnits="userSpaceOnUse"
id="linearGradient3967"
xlink:href="#linearGradient3990"
inkscape:collect="always" />
<linearGradient
y2="917.51282"
x2="-555.82379"
y1="920.41797"
x1="-1237.1112"
gradientTransform="matrix(-1.3798164,-1.6569612,0.7684458,-0.63991489,-2195.6367,413.8935)"
gradientUnits="userSpaceOnUse"
id="linearGradient4016"
xlink:href="#linearGradient4039"
inkscape:collect="always" />
<linearGradient
id="linearGradient3851-62">
<stop
id="stop3853-38"
offset="0"
style="stop-color:#321e1d;stop-opacity:1" />
<stop
style="stop-color:#555548;stop-opacity:0"
offset="0.01739271"
id="stop3855-2" />
<stop
id="stop3857-62"
offset="1"
style="stop-color:#ffffff;stop-opacity:0;" />
</linearGradient>
<linearGradient
y2="910.64618"
x2="-551.12549"
y1="915.73645"
x1="-1242.2334"
gradientTransform="matrix(0.85312044,-1.9803029,0.91840135,0.39565006,2182.2918,-885.93458)"
gradientUnits="userSpaceOnUse"
id="linearGradient4065"
xlink:href="#linearGradient3851-62"
inkscape:collect="always" />
<linearGradient
y2="915.4801"
x2="-555.86682"
y1="919.71448"
x1="-1238.0465"
gradientTransform="matrix(1.3829904,1.654313,-0.7672176,0.6413869,2529.8389,3432.8719)"
gradientUnits="userSpaceOnUse"
id="linearGradient4106"
xlink:href="#linearGradient4129"
inkscape:collect="always" />
<linearGradient
y2="917.18665"
x2="-866.86804"
y1="918.09875"
x1="-1242.5582"
gradientTransform="matrix(1.3829904,1.654313,-0.7672176,0.6413869,2930.535,3096.9376)"
gradientUnits="userSpaceOnUse"
id="linearGradient4196"
xlink:href="#linearGradient4227"
inkscape:collect="always" />
<linearGradient
y2="917.51282"
x2="-555.82379"
y1="919.71448"
x1="-1238.0465"
gradientTransform="matrix(-0.83179183,1.989334,-0.83312221,-0.35033011,1447.5752,4603.6836)"
gradientUnits="userSpaceOnUse"
id="linearGradient4253"
xlink:href="#linearGradient4276"
inkscape:collect="always" />
</defs>
<sodipodi:namedview
pagecolor="#ffffff"
bordercolor="#666666"
borderopacity="1"
objecttolerance="10"
gridtolerance="10"
guidetolerance="10"
inkscape:pageopacity="0"
inkscape:pageshadow="2"
inkscape:window-width="1280"
inkscape:window-height="750"
id="namedview2818"
showgrid="false"
inkscape:zoom="0.25"
inkscape:cx="668.45545"
inkscape:cy="769.26341"
inkscape:window-x="-8"
inkscape:window-y="-8"
inkscape:window-maximized="1"
inkscape:current-layer="svg2816"
showguides="true"
inkscape:guide-bbox="true" />
<g
id="g3668">
<path
sodipodi:nodetypes="ccccccc"
id="path2831-1"
d="m 1971.5575,1939.9137 -1797.08691,-0.1258 c -11.0291,-1.2221 -8.5403,-6.713 -5.9958,-12.2215 L 1069.3546,128.0808 c 3.3139,-5.2772 6.2883,-4.4372 9.0861,-0.4108 l 900.8561,1799.4363 c 4.5781,9.1667 1.5811,13.1503 -7.7393,12.8074 z"
style="fill:none;stroke:#3a393b;stroke-width:22.50000000000000000;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0;filter:url(#filter3777);opacity:0.53974895" />
<path
sodipodi:nodetypes="cccc"
id="path2828"
d="M 1143.3083,1084.3217 158.69119,1926.0618 1060.5107,124.10214 1143.3083,1084.3217 z"
style="fill:url(#linearGradient3651);fill-opacity:1;fill-rule:nonzero;stroke:#000000;stroke-opacity:1" />
<path
sodipodi:nodetypes="ccccc"
id="rect3781"
d="m 1060.5637,125.61959 c 13.4152,80.71591 11.94,94.79031 -18.0349,140.07316 L 245.92029,1844.832 161.31739,1921.7588 1060.5637,125.61959 z"
style="fill:url(#linearGradient3806);fill-opacity:1;fill-rule:nonzero;stroke:none" />
<path
sodipodi:nodetypes="cccccc"
id="rect3781-0-9"
d="m 1147.188,1083.1536 -50.1671,40.0537 -52.7887,-888.7261 c -4.0533,-47.4341 -6.2416,-43.17076 -6.5492,-68.17004 l 25.1004,-48.95208 84.4046,965.79452 z"
style="fill:url(#linearGradient3967);fill-opacity:1;fill-rule:nonzero;stroke:none" />
<path
sodipodi:nodetypes="cccc"
id="path2828-4"
d="M 1188.9362,1609.9939 1060.9788,123.94021 1963.9529,1926.2261 1188.9362,1609.9939 z"
style="fill:url(#linearGradient3659);fill-opacity:1;fill-rule:nonzero;stroke:#000000;stroke-opacity:1" />
<path
sodipodi:nodetypes="ccccc"
id="rect3781-9"
d="m 1060.9071,120.07731 c 24.1749,30.04558 39.608,75.93991 48.9654,112.17843 l 179.3742,1415.10436 -98.4276,-38.4391 -129.912,-1488.84369 z"
style="fill:url(#linearGradient3918);fill-opacity:1;fill-rule:nonzero;stroke:none" />
<path
sodipodi:nodetypes="cccc"
id="path2828-1"
d="M 743.40929,1423.8349 1964.8794,1926.0085 158.92799,1925.81 743.40929,1423.8349 z"
style="fill:url(#linearGradient3675);fill-opacity:1;fill-rule:nonzero;stroke:#000000;stroke-opacity:1" />
<path
sodipodi:nodetypes="cccccc"
id="rect3781-0"
d="m 1963.6891,1926.5277 -56.7139,-24.6169 -795.9854,-1603.05217 c -21.9472,-24.37845 -34.3449,-39.62306 -41.2192,-51.95192 -1.1264,-32.3188 -2.943,-61.0813 -9.9138,-126.2626 l 903.8323,1805.88359 z"
style="fill:url(#linearGradient3828);fill-opacity:1;fill-rule:nonzero;stroke:none" />
<path
sodipodi:nodetypes="cccc"
id="path2828-4-7"
d="m 745.26609,1425.0475 397.42281,-339.0381 55.3298,523.5716 -452.75261,-184.5335 z"
style="fill:url(#linearGradient3721);fill-opacity:1;fill-rule:nonzero;stroke:#000000;stroke-width:4;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none" />
<path
inkscape:transform-center-y="624.859"
inkscape:transform-center-x="758.12355"
sodipodi:nodetypes="cccccc"
id="rect3781-8"
d="m 742.72829,1426.2554 c 17.4821,6.7504 20.8419,8.2827 35.806,14.4205 -16.1593,13.8305 -69.88,86.4885 -91.4281,103.8499 l -428.4072,362.6992 -98.8195,18.3883 582.8488,-499.3579 z"
style="fill:url(#linearGradient4106);fill-opacity:1;fill-rule:nonzero;stroke:none" />
<path
inkscape:transform-center-y="347.22075"
inkscape:transform-center-x="-821.22079"
sodipodi:nodetypes="cccccc"
id="rect3781-0-8-6"
d="m 1962.8676,1925.4594 -68.0643,-1.0486 -1174.86681,-479.6332 23.5048,-18.7167 470.76241,191.9416 748.6639,307.4569 z"
style="fill:url(#linearGradient4253);fill-opacity:1;fill-rule:nonzero;stroke:none" />
<path
sodipodi:nodetypes="ccccc"
id="rect3781-0-8"
d="m 159.98259,1925.4405 50.2958,-42.8864 1643.00831,0.1531 110.3276,42.727 -1803.63171,0.01 z"
style="fill:url(#linearGradient3877);fill-opacity:1;fill-rule:nonzero;stroke:none" />
<path
inkscape:transform-center-y="369.96725"
inkscape:transform-center-x="-887.51544"
sodipodi:nodetypes="ccccccc"
id="rect3781-0-7"
d="m 1199.8469,1610.9874 -2.1608,-22.3386 610.5884,235.1678 c 39.4555,18.7661 69.1058,27.2993 88.8249,43.327 12.6947,5.2081 34.7241,12.6345 46.1135,16.4736 13.9264,9.2219 11.5065,23.9583 20.3177,41.5431 l -763.6837,-314.1729 z"
style="fill:url(#linearGradient4065);fill-opacity:1;fill-rule:nonzero;stroke:none" />
<path
sodipodi:nodetypes="ccccccc"
id="path2831"
d="m 1958.5868,1931.807 -1797.08691,-0.1258 c -11.0291,-1.2221 -8.5403,-6.713 -5.9958,-12.2215 L 1056.3839,119.97408 c 3.3139,-5.27718 6.2883,-4.43721 9.0861,-0.4108 l 900.8561,1799.43632 c 4.5781,9.1667 1.5811,13.1503 -7.7393,12.8074 z"
style="fill:none;stroke:#000000;stroke-width:12.19999981;stroke-miterlimit:4;stroke-opacity:1;stroke-dasharray:none;stroke-dashoffset:0" />
<path
sodipodi:nodetypes="cccccc"
id="rect3781-0-98"
d="m 160.09059,1924.1505 25.5248,-54.5322 52.0681,-38.5691 899.32641,-780.8749 c 4.7998,18.518 1.8803,6.9336 6.1315,33.989 l -983.05081,839.9872 z"
style="fill:url(#linearGradient4016);fill-opacity:1;fill-rule:nonzero;stroke:none" />
<path
inkscape:transform-center-y="624.859"
inkscape:transform-center-x="758.12355"
sodipodi:nodetypes="ccccc"
id="rect3781-8-2"
d="m 1141.0494,1090.571 c -7.8922,86.6075 -17.7158,81.5443 -53.2471,118.0205 l -263.40721,244.6992 -74.9445,-29.2367 391.59881,-333.483 z"
style="fill:url(#linearGradient4196);fill-opacity:1;fill-rule:nonzero;stroke:none" />
</g>
</svg>
Side by Side

After

Width:  |  Height:  |  Size: 17 KiB

1
docs/source/image/conda.svg Normal file
View File

@ -0,0 +1 @@
<svg id="Layer_1" xmlns="http://www.w3.org/2000/svg" viewBox="0 0 127 127"><style>.st0{fill:#43b02a}</style><path class="st0" d="M13.8 81.2c-2.1 4.2-3.8 8.6-5.2 13.1 4.7 1.3 9.4 2.2 14.2 2.6.1-3.8.4-7.4.9-11-3.4-1.3-6.7-2.9-9.9-4.7zM33 32.8c-2.8 0-5.5.2-8.3.6.4 2.8.8 5.5 1.5 8.3 1.9-3.2 4.2-6.1 6.8-8.7v-.2zM10.5 98.7c3.6 5.5 8.1 10.4 13.2 14.5-.5-4.3-.9-8.4-.9-12.5-4.2-.4-8.3-1.1-12.3-2zM43 3.4c-5 1.7-9.6 4-14 6.8 3.3.6 6.5 1.3 9.7 2.3 1.2-3.1 2.7-6.1 4.3-9.1zM63.6 0c-2.5 0-4.9.2-7.3.4 3.4 2.4 6.6 4.9 9.7 7.7l2.5 2.3-2.5 2.5c-2.1 2-4.1 4.1-6 6.4v.1s-.4.4-1 1.1c1.5-.2 3-.2 4.6-.2 23.9 0 43.3 19.4 43.3 43.3s-19.4 43.3-43.3 43.3c-8.3 0-16.1-2.3-22.7-6.4-3.3.4-6.5.6-9.8.6-1.5 0-3 0-4.6-.1.1 4.9.6 10 1.4 15.3 10.2 6.9 22.4 10.9 35.6 10.9 35.1 0 63.6-28.5 63.6-63.6C127.2 28.5 98.7 0 63.6 0z"/><path class="st0" d="M55.1 15c1.3-1.5 2.6-3 3.9-4.4-3-2.5-6.1-4.9-9.4-6.9-2 3.4-3.8 7-5.3 10.6 2.9 1.1 5.7 2.3 8.4 3.6 1.3-1.6 2.2-2.6 2.4-2.9zM19.4 34.1c-4.7.8-9.3 2.1-13.8 3.7 1.8 4.6 4.1 9.1 6.7 13.3 3-2.1 6.1-4.1 9.3-5.8-1-3.7-1.7-7.4-2.2-11.2zM11.1 58.1c-3.4 2.8-6.6 5.8-9.6 9.2 3.3 2.9 6.8 5.5 10.5 7.9 1.7-3 3.6-6 5.6-8.8-2.2-2.6-4.4-5.4-6.5-8.3zM27.3 87.3c-.4 3.2-.7 6.5-.8 9.9 3.2.2 6.4.2 9.6 0-3.4-2.8-6.4-6.1-8.8-9.9zM36.6 18.1c-4-1.1-8.1-2-12.2-2.5-.4 4.2-.4 8.3-.1 12.4 3.3-.4 6.5-.6 9.8-.6.6-3.2 1.5-6.3 2.5-9.3zM42.3 19.9c-.8 2.4-1.5 4.8-2.1 7.2 2.8-1.8 5.8-3.3 8.9-4.4-2.2-1-4.5-1.9-6.8-2.8zM.5 72.1c.8 6.2 2.5 12.1 5 17.5C6.8 86 8.3 82.4 10 79c-3.3-2.1-6.4-4.4-9.5-6.9zM18.8 18.5c-3.8 3.8-7.1 8-9.9 12.6 3.3-1 6.6-1.8 10-2.4-.2-3.4-.3-6.8-.1-10.2zM15 55.2c1.6 2.3 3.4 4.6 5.3 6.8.2-4 .8-7.8 2-11.5-2.5 1.4-5 3-7.3 4.7zM15.8 77.3c2.7 1.5 5.4 2.9 8.3 4.1-1.7-3.7-2.8-7.6-3.4-11.8-1.8 2.5-3.4 5.1-4.9 7.7zM8.4 54.1c-2-3.2-3.8-6.5-5.4-10C1.2 49.7.1 55.7 0 61.8c2.7-2.8 5.5-5.4 8.4-7.7z"/></svg>
Side by Side

After

Width:  |  Height:  |  Size: 1.8 KiB

BIN
docs/source/image/ea.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 6.2 KiB

BIN
docs/source/image/ea_big.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 16 KiB

52
docs/source/index.rst Normal file
View File

@ -0,0 +1,52 @@
Elastic AI
==========
.. image:: image/ea_big.png
:alt: EA
Elastic AI abbreviated as EA, In future documents, we will all call it EA.
EA is a fast, typo-tolerant search engine for building delightful search experiences based on AI and IR.
and so EA is open source `github <https://github.com/gottingen/ea>`_.
EA focuses on building a search service framework suitable for artificial intelligence access.
The search system contains many components, including explicit requirements such as engines,
sorting, etc., but also includes configuration systems, statistics, etc. that serve the search business.
Contents
--------
.. toctree::
:caption: ENGLISH
en/overview
.. toctree::
en/install
.. toctree::
en/meta/introduction
en/meta/config
en/meta/atomic
.. toctree::
:caption: API REFERENCE
en/api/meta
.. toctree::
:caption: 中文文档
cn/overview
.. toctree::
cn/install