diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml deleted file mode 100644 index 6ee41e3..0000000 --- a/.github/workflows/pages.yml +++ /dev/null @@ -1,52 +0,0 @@ -name: Pages - -on: - push: - branches: [main] - workflow_dispatch: - -permissions: - contents: read - pages: write - id-token: write - -concurrency: - group: pages - cancel-in-progress: false - -jobs: - build: - runs-on: ubuntu-latest - steps: - - name: Checkout - uses: actions/checkout@v4 - - - name: Configure Pages - uses: actions/configure-pages@v5 - - - name: Set up Python - uses: actions/setup-python@v5 - with: - python-version: "3.12" - - - name: Install docs dependencies - run: python -m pip install mkdocs-material - - - name: Build site - run: mkdocs build - - - name: Upload artifact - uses: actions/upload-pages-artifact@v3 - with: - path: site - - deploy: - environment: - name: github-pages - url: ${{ steps.deployment.outputs.page_url }} - needs: build - runs-on: ubuntu-latest - steps: - - name: Deploy to GitHub Pages - id: deployment - uses: actions/deploy-pages@v4 diff --git a/.readthedocs.yaml b/.readthedocs.yaml new file mode 100644 index 0000000..77af0b8 --- /dev/null +++ b/.readthedocs.yaml @@ -0,0 +1,13 @@ +version: 2 + +build: + os: ubuntu-24.04 + tools: + python: "3.12" + +mkdocs: + configuration: mkdocs.yml + +python: + install: + - requirements: docs/requirements.txt diff --git a/README.md b/README.md index 55bd42b..9b913d2 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ The first wedge is migration: teams can prototype in a high-level framework, val > AG-UI standardizes agent-to-frontend interaction. LiteLLM standardizes model-provider access. AgentBridge standardizes app-to-agent-framework compatibility. -Documentation site target: [GitHub Pages](http://sparshnagpal.com/agent-framework-connector/). The same source docs remain readable directly in this repository under [docs](docs/index.md). +Documentation site target: [Read the Docs](https://agentbridge.readthedocs.io/). The same source docs remain readable directly in this repository under [docs](docs/index.md). ## What This Repo Contains diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 0000000..d14bca3 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1 @@ +mkdocs-material>=9.5,<10 diff --git a/mkdocs.yml b/mkdocs.yml index b16b672..95cdfb6 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,6 +1,6 @@ site_name: AgentBridge site_description: Define an agent once and run it across multiple agent frameworks. -site_url: http://sparshnagpal.com/agent-framework-connector/ +site_url: https://agentbridge.readthedocs.io/ repo_url: https://github.com/0sparsh2/agent-framework-connector repo_name: 0sparsh2/agent-framework-connector edit_uri: edit/main/docs/ diff --git a/pyproject.toml b/pyproject.toml index f0ab0a9..3e209a6 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -48,7 +48,7 @@ dev = [ Homepage = "https://github.com/0sparsh2/agent-framework-connector" Repository = "https://github.com/0sparsh2/agent-framework-connector" Issues = "https://github.com/0sparsh2/agent-framework-connector/issues" -Documentation = "http://sparshnagpal.com/agent-framework-connector/" +Documentation = "https://agentbridge.readthedocs.io/" [tool.pytest.ini_options] testpaths = ["tests"]