Skip to content

Commit

Permalink
refactor sphinx doc workflow
Browse files Browse the repository at this point in the history
  • Loading branch information
pan-x-c committed Jan 22, 2024
1 parent 0396ae9 commit f00fdd0
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 10 deletions.
20 changes: 10 additions & 10 deletions .github/workflows/sphinx_docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,27 +18,27 @@ jobs:
OS: ${{ matrix.os }}
PYTHON: '3.9'
steps:
- name: Checkout repository
- name: Checkout Repository
uses: actions/checkout@master
- name: Setup Python ${{ matrix.python-version }}
uses: actions/setup-python@master
with:
python_version: ${{ matrix.python-version }}
- id: deployment
- name: Install Dependencies
run: |
pip install -q -e .[full]
- id: build
name: Build Documentation
uses: sphinx-notes/pages@v3
with:
documentation_path: ./docs/sphinx_doc/source
python_version: ${{ matrix.python-version }}
publish: false
requirements_path: ./docs/sphinx_doc/requirements.txt
run: |
cd docs/sphinx_doc
make clean html
- name: Upload Documentation
uses: actions/upload-artifact@v3
with:
name: SphinxDoc
path: ${{ steps.deployment.outputs.artifact }}
path: 'docs/sphinx_doc/build'
- uses: peaceiris/actions-gh-pages@v3
if: ${{ github.event_name == 'push' }}
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ${{ steps.deployment.outputs.artifact }}
publish_dir: 'docs/sphinx_doc/build'
40 changes: 40 additions & 0 deletions docs/sphinx_doc/source/agentscope.agents.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,14 @@
Agents package
==========================

operator module
-------------------------------

.. automodule:: agentscope.agents.operator
:members:
:undoc-members:
:show-inheritance:

agent module
-------------------------------

Expand All @@ -13,6 +21,38 @@ rpc_agent module
-------------------------------

.. automodule:: agentscope.agents.rpc_agent
:members:
:undoc-members:
:show-inheritance:

user_agent module
-------------------------------

.. automodule:: agentscope.agents.user_agent
:members:
:undoc-members:
:show-inheritance:

dialog_agent module
-------------------------------

.. automodule:: agentscope.agents.dialog_agent
:members:
:undoc-members:
:show-inheritance:

dict_dialog_agent module
-------------------------------

.. automodule:: agentscope.agents.dict_dialog_agent
:members:
:undoc-members:
:show-inheritance:

rpc_dialog_agent module
-------------------------------

.. automodule:: agentscope.agents.dict_dialog_agent
:members:
:undoc-members:
:show-inheritance:

0 comments on commit f00fdd0

Please sign in to comment.