Skip to content

Commit a7a33d3

Browse files
abyvinodmkieranparsons
abyvinodm
authored and
kieranparsons
committed
Create release 1.0.2
1 parent 86464e7 commit a7a33d3

File tree

75 files changed

+861
-319
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

75 files changed

+861
-319
lines changed

‎.github/workflows/deploy_gh_pages.yaml

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Copyright (C) 2023 Mitsubishi Electric Research Laboratories (MERL)
2+
#
3+
# SPDX-License-Identifier: AGPL-3.0-or-later
4+
5+
name: Publish Sphinx Documentation
6+
7+
on:
8+
push:
9+
branches:
10+
- "**"
11+
12+
jobs:
13+
publish_sphinx_docs:
14+
runs-on: ubuntu-latest
15+
permissions:
16+
contents: write
17+
steps:
18+
- name: Checkout repo
19+
uses: actions/checkout@v4
20+
21+
- name: Set up Python 3.10
22+
uses: actions/setup-python@v5
23+
with:
24+
python-version: "3.10"
25+
26+
- name: Install dependencies
27+
run: |
28+
sudo apt-get install libcdd-dev libgmp-dev python3-dev
29+
python3 -m pip install --upgrade pip
30+
31+
- name: Install pycvxset with docs and testing dependencies
32+
run: |
33+
pip install --editable ".[with_docs_and_tests]"
34+
35+
- name: Build the docs from sphinx
36+
run: |
37+
cd docs
38+
sphinx-build -b html source build
39+
make html
40+
41+
- name: Deploy
42+
uses: peaceiris/actions-gh-pages@v4
43+
with:
44+
publish_branch: gh-pages
45+
github_token: ${{ secrets.GITHUB_TOKEN }}
46+
publish_dir: docs/build/html
47+
force_orphan: true

‎.github/workflows/requirements-dev.txt

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Copyright (C) 2020-2024 Mitsubishi Electric Research Laboratories (MERL)
1+
# Copyright (C) 2020-2025 Mitsubishi Electric Research Laboratories (MERL)
22
#
33
# SPDX-License-Identifier: AGPL-3.0-or-later
44

‎.github/workflows/run_diagnostics_and_tests_linux.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Copyright (C) 2023 Mitsubishi Electric Research Laboratories (MERL)
1+
# Copyright (C) 2025 Mitsubishi Electric Research Laboratories (MERL)
22
#
33
# SPDX-License-Identifier: AGPL-3.0-or-later
44

‎.github/workflows/run_diagnostics_and_tests_macos.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Copyright (C) 2023 Mitsubishi Electric Research Laboratories (MERL)
1+
# Copyright (C) 2025 Mitsubishi Electric Research Laboratories (MERL)
22
#
33
# SPDX-License-Identifier: AGPL-3.0-or-later
44

‎.github/workflows/run_diagnostics_and_tests_windows.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Copyright (C) 2023 Mitsubishi Electric Research Laboratories (MERL)
1+
# Copyright (C) 2025 Mitsubishi Electric Research Laboratories (MERL)
22
#
33
# SPDX-License-Identifier: AGPL-3.0-or-later
44

‎.github/workflows/static_checks.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Copyright (C) 2020-2024 Mitsubishi Electric Research Laboratories (MERL)
1+
# Copyright (C) 2020-2025 Mitsubishi Electric Research Laboratories (MERL)
22
#
33
# SPDX-License-Identifier: AGPL-3.0-or-later
44

‎.gitignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Copyright (C) 2020-2024 Mitsubishi Electric Research Laboratories (MERL)
1+
# Copyright (C) 2020-2025 Mitsubishi Electric Research Laboratories (MERL)
22
# Copyright (c) 2019 Tor Aksel N. Heirung
33
#
44
# SPDX-License-Identifier: AGPL-3.0-or-later

‎.pre-commit-config.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Copyright (C) 2020-2024 Mitsubishi Electric Research Laboratories (MERL)
1+
# Copyright (C) 2020-2025 Mitsubishi Electric Research Laboratories (MERL)
22
#
33
# SPDX-License-Identifier: AGPL-3.0-or-later
44

‎.reuse/dep5

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
22

33
Files: .vscode/*
4-
Copyright: 2020-2024 Mitsubishi Electric Research Laboratories (MERL)
4+
Copyright: 2020-2025 Mitsubishi Electric Research Laboratories (MERL)
55
License: AGPL-3.0-or-later
66

77
Files: examples/*
8-
Copyright: 2020-2024 Mitsubishi Electric Research Laboratories (MERL)
8+
Copyright: 2020-2025 Mitsubishi Electric Research Laboratories (MERL)
99
License: AGPL-3.0-or-later
1010

1111
Files: docs/*
12-
Copyright: 2020-2024 Mitsubishi Electric Research Laboratories (MERL)
12+
Copyright: 2020-2025 Mitsubishi Electric Research Laboratories (MERL)
1313
License: AGPL-3.0-or-later
1414

1515
Files: MANUAL.pdf
16-
Copyright: 2020-2024 Mitsubishi Electric Research Laboratories (MERL)
16+
Copyright: 2020-2025 Mitsubishi Electric Research Laboratories (MERL)
1717
License: AGPL-3.0-or-later

‎.vscode/README_VSCode.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
Copyright (C) 2020-2024 Mitsubishi Electric Research Laboratories (MERL)
2+
Copyright (C) 2020-2025 Mitsubishi Electric Research Laboratories (MERL)
33
44
SPDX-License-Identifier: AGPL-3.0-or-later
55
-->

‎CHANGELOG.md

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<!--
2+
Copyright (C) 2020-2025 Mitsubishi Electric Research Laboratories (MERL)
3+
4+
SPDX-License-Identifier: CC-BY-4.0
5+
-->
6+
# 1.0.2 / 2025-02-13
7+
8+
- Set up documentation website using Github Pages, which is released under CC-BY-4.0 license
9+
10+
# 1.0.1 / 2024-10-14
11+
12+
- Restrict pycddlib to 2.1.8
13+
- Minor bugfixes
14+
15+
# 1.0.0 / 2024-09-27
16+
17+
Initial release

‎CONTRIBUTING.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
Copyright (C) 2020-2024 Mitsubishi Electric Research Laboratories (MERL)
2+
Copyright (C) 2020-2025 Mitsubishi Electric Research Laboratories (MERL)
33
SPDX-License-Identifier: AGPL-3.0-or-later
44
-->
55

0 commit comments

Comments
 (0)