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
13 changes: 6 additions & 7 deletions .github/workflows/apidocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,15 +8,14 @@ jobs:

steps:
- uses: actions/checkout@master
- name: Set up Python 3.8
uses: actions/setup-python@v2
- name: Set up Python 3.12
uses: actions/setup-python@v5
with:
python-version: 3.8
python-version: 3.12
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
python-version: 3.12
python-version: 3.x

If you want to minimize maintenance


- name: Install requirements for documentation generation
run: |
python -m pip install --upgrade pip setuptools wheel
python -m pip install pytest pydoctor>=22.3.0 .
python -m pip install .[docs]

- name: Generate API documentation with pydoctor
run: |
Expand All @@ -30,12 +29,12 @@ jobs:
--html-output=./apidocs \
--project-base-dir="." \
--docformat=restructuredtext \
--system-class=docstring_parser.tests._pydoctor.HidesTestsPydoctorSystem \
--privacy="HIDDEN:docstring_parser.tests" \
--intersphinx=https://docs.python.org/3/objects.inv \
./docstring_parser

- name: Push API documentation to Github Pages
uses: peaceiris/actions-gh-pages@v3
uses: peaceiris/actions-gh-pages@v4
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./apidocs
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ test = [
"pytest",
]
docs = [
"pydoctor >= 22.3.0",
"pydoctor >= 25.4.0",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My only remaining comment is about this change? Is it needed?

]
dev = [
"docstring_parser[test]",
Expand Down
Loading