Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update index.rst for AgentQnA doc refactor #250

Merged
merged 22 commits into from
Nov 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,8 @@
# files and directories to ignore when looking for source files.
exclude_patterns = [
'scripts/*',
'examples/AgentQnA/deploy/index.rst',
'examples/AgentQnA/deploy/xeon.md'
]
try:
import sphinx_rtd_theme
Expand Down
9 changes: 8 additions & 1 deletion examples/AgentQnA/AgentQnA_Guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -43,5 +43,12 @@ The worker agent uses the retrieval tool to generate answers to the queries post

Deployment
**********
Here are some deployment options, depending on your hardware and environment:

See the :ref:`agentqna-example-deployment`.
Single Node
yinghu5 marked this conversation as resolved.
Show resolved Hide resolved
+++++++++++++++
.. toctree::
:maxdepth: 1

Xeon Scalable Processor </GenAIExamples/AgentQnA/docker_compose/intel/cpu/xeon/README.md>
Gaudi </GenAIExamples/AgentQnA/docker_compose/intel/hpu/gaudi/README.md>
7 changes: 2 additions & 5 deletions examples/AgentQnA/deploy/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,6 @@ AgentQnA Example Deployment Options
Here are some deployment options, depending on your hardware and environment:

Single Node
***********

.. toctree::
:maxdepth: 1

Xeon Scalable Processor <xeon>
- **Xeon Scalable Processor**: `Xeon <https://opea-project.github.io/latest/GenAIExamples/AgentQnA/docker_compose/intel/cpu/xeon/README.html>`_
- **Gaudi**: `Gaudi <https://opea-project.github.io/latest/GenAIExamples/AgentQnA/docker_compose/intel/hpu/gaudi/README.html>`_
1 change: 0 additions & 1 deletion examples/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@ GenAIExamples are designed to give developers an easy entry into generative AI,
ChatQnA/ChatQnA_Guide
ChatQnA/deploy/index
AgentQnA/AgentQnA_Guide
AgentQnA/deploy/index
CodeGen/deploy/gaudi.md
CodeGen/deploy/index

Expand Down