Skip to content

Commit e681872

Browse files
committed
chore: Added a workflow to publish to PyPI.
chore: Added badges to README.
1 parent ee0c2d9 commit e681872

File tree

2 files changed

+34
-2
lines changed

2 files changed

+34
-2
lines changed

.github/workflows/pypi-publish.yml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: pypi-publish
2+
3+
on:
4+
release:
5+
types: [published]
6+
7+
permissions:
8+
contents: read
9+
10+
jobs:
11+
release-build:
12+
runs-on: ubuntu-latest
13+
14+
steps:
15+
- uses: actions/checkout@v4
16+
17+
- name: Install uv
18+
uses: astral-sh/setup-uv@v5
19+
20+
- name: Install the project
21+
run: uv sync --all-groups
22+
23+
- name: Build release distributions
24+
run: |
25+
uv build
26+
27+
- name: Upload distributions
28+
env:
29+
UV_PUBLISH_TOKEN: ${{ secrets.UV_PUBLISH_TOKEN }}
30+
run: |
31+
# Requires UV_PUBLISH_TOKEN repository secret to be set
32+
uv publish

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](code_of_conduct.md)
1+
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](code_of_conduct.md) [![PyPI](https://img.shields.io/pypi/v/sphinx-mcp?label=pypi%20package)](https://pypi.org/project/sphinx-mcp/#history) ![GitHub commits since latest release](https://img.shields.io/github/commits-since/anirbanbasu/sphinx-mcp/latest)
22

33
# sphinx-mcp
44

5-
`sphinx-mcp` is a Sphinx extension for documenting MCP tools, prompts, resources and resource templates. The documentation of the extension including examples of MCP server documentation is available in the pre-compiled PDF: [sphinx-mcp.pdf](https://raw.githubusercontent.com/anirbanbasu/sphinx-mcp/master/sphinx-mcp.pdf).
5+
`sphinx-mcp` is a Sphinx extension for documenting MCP tools, prompts, resources and resource templates. The documentation of the extension including examples of MCP server documentation is available in the pre-compiled PDF: [sphinx-mcp.pdf](sphinx-mcp.pdf).
66

77
# Limitations
88
- The limitations of the extension are documented in the aforementioned PDF.

0 commit comments

Comments
 (0)