Skip to content
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
49 changes: 49 additions & 0 deletions .github/workflows/pydoctor.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
name: API docs

on:
push:
branches: [master]

permissions:
contents: read
pages: write
id-token: write

concurrency:
group: "pages"
cancel-in-progress: true

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v6
- name: Set up Python
uses: actions/setup-python@v6
with:
python-version: "3.13"
- name: Install dependencies
run: |
sudo apt update
sudo apt install libsvn-dev
python -m pip install --upgrade pip
pip install -e .
pip install pydoctor
- name: Build API docs
run: |
pydoctor --introspect-c-modules -c subvertpy.cfg --make-html subvertpy
- name: Upload Pages artifact
uses: actions/upload-pages-artifact@v3
with:
path: apidocs

deploy:
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,4 @@ apidocs
*~
.tox/
.pybuild
subvertpy.egg-info
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ clean::
rm -f subvertpy/*.so subvertpy/*.o subvertpy/*.pyc

pydoctor:
$(PYDOCTOR) $(PYDOCTOR_OPTIONS) --introspect-c-modules -c subvertpy.cfg --make-html
$(PYDOCTOR) $(PYDOCTOR_OPTIONS) --introspect-c-modules -c subvertpy.cfg --make-html subvertpy

style:
$(RUFF) check
Expand Down
12 changes: 7 additions & 5 deletions subvertpy.cfg
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
packages: subvertpy
docformat: restructuredtext
projectname: subvertpy
projecturl: https://jelmer.uk/subvertpy/
htmloutput: apidocs
# subvertpy.cfg (TOML format)
packages = "subvertpy"
docformat = "restructuredtext"
projectname = "subvertpy"
projecturl = "https://jelmer.uk/subvertpy/"
htmloutput = "apidocs"

2 changes: 1 addition & 1 deletion subvertpy/server.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ def stat(self, path, revnum):
"""Stat a path.

Should return a dictionary with the following keys: name, kind, size,
has-props, created-rev, created-date, last-author.
has-props, created-rev, created-date, last-author.
"""
raise NotImplementedError(self.stat)

Expand Down
Loading