openscvx 0.5.2.dev2__tar.gz → 2.dev1__tar.gz

{openscvx-0.5.2.dev2 → openscvx-2.dev1}/.github/workflows/_docs.yml

@@ -12,6 +12,11 @@ jobs:
   docs:
     name: 📖 Documentation
     runs-on: ubuntu-latest
+    env:
+      # Material stderr banner (MkDocs 2.0 blog); CI uses MkDocs 1.x + --strict.
+      NO_MKDOCS_2_WARNING: "true"
+      # ProperDocs may emit a follow-up WARNING; keep --strict clean.
+      DISABLE_MKDOCS_2_WARNING: "true"
 
     steps:
     - name: Checkout repository
@@ -38,20 +43,23 @@ jobs:
     - name: Cache MkDocs build
       uses: actions/cache@v4
       with:
-        key: mkdocs-material-${{ hashFiles('mkdocs.yml', 'docs/**') }}
+        key: mkdocs-material-${{ hashFiles('mkdocs.yml', 'docs/**', 'material/overrides/**', 'scripts/gen_ref_pages.py', 'scripts/gen_example_pages.py', 'scripts/mkdocs_copy_viser_client_hook.py') }}
         path: .cache
         restore-keys: |
           mkdocs-material-
 
     - name: Install system dependencies
-      run: sudo apt-get update && sudo apt-get install -y pngquant
+      run: >-
+        sudo apt-get update &&
+        sudo apt-get install -y pngquant libcairo2-dev libfreetype6-dev libffi-dev
+        libjpeg-dev libpng-dev zlib1g-dev
 
     # - name: Install MkDocs Material Insiders
     #   run: uv pip install --system git+https://${{ secrets.MKDOCS_INSIDERS_TOKEN }}@github.com/squidfunk/mkdocs-material-insiders.git
 
     - name: Install documentation tools
       run: |
-        uv pip install --system mkdocs-material mkdocstrings-python
+        uv pip install --system "mkdocs-material[imaging]" mkdocstrings-python
         uv pip install --system mkdocs-gen-files mkdocs-literate-nav mkdocs-section-index
         uv pip install --system mike
 

{openscvx-0.5.2.dev2 → openscvx-2.dev1}/.gitignore

@@ -209,7 +209,9 @@ check_lint.py
 MUJOCO_LOG.TXT
 
 # MkDocs Material Insiders (installed from GitHub in CI, not committed)
-material/
-# But allow custom overrides to be committed
+# Ignore contents of material/ but not material/overrides/ (Git cannot un-ignore
+# paths inside an ignored directory when the rule is material/).
+material/*
 !material/overrides/
+!material/overrides/**
 src/

{openscvx-0.5.2.dev2 → openscvx-2.dev1}/CONTRIBUTING.md

@@ -20,7 +20,6 @@ pip install -e ".[test]"
 ```
 
 For additional features, you can install optional dependencies:
-- `pip install -e ".[gui]"` - GUI visualization tools
 - `pip install -e ".[cvxpygen]"` - Code generation support
 - `pip install -e ".[stl]"` - STL (Signal Temporal Logic) constraints
 
@@ -204,11 +203,17 @@ def solve(self, max_iterations: int = 100) -> OptimizationResult:
 To preview documentation locally, first install the dependencies:
 
 ```bash
-pip install mkdocs-material mkdocstrings-python mkdocs-gen-files mkdocs-literate-nav mkdocs-section-index
+pip install "mkdocs-material[imaging]" mkdocstrings-python mkdocs-gen-files mkdocs-literate-nav mkdocs-section-index
 ```
 
+The `social` plugin (enabled in `mkdocs.yml`) uses **CairoSVG**, which loads the native **Cairo** library. A `pip`-only `cairosvg` on macOS often cannot find `libcairo` and will spam warnings during `mkdocs build` / `mkdocs serve`. Install Cairo into the same environment (for example `conda install -c conda-forge cairo cairosvg`) or install Cairo via Homebrew so the dynamic linker can resolve it. Uninstalling `cairosvg` does not silence the build: the plugin will warn on every page that imaging dependencies are missing.
+
 Then serve the documentation locally:
 
 ```bash
 mkdocs serve
 ```
+
+To silence MkDocs 2.0 / ProperDocs notices when building with **`--strict`**, set **`NO_MKDOCS_2_WARNING=true`** (Material’s stderr banner) and, if you use ProperDocs, **`DISABLE_MKDOCS_2_WARNING=true`** for the pip-style WARNING; the documentation workflow sets both for CI.
+
+The version dropdown uses Material’s **mike** integration and expects a `versions.json` at the site root. Plain `mkdocs serve` does not run `mike deploy`, so the repo includes a minimal **`docs/versions.json`** (copied into the build) to avoid a 404 in local previews. On **GitHub Pages**, CI replaces the published root with **`mike deploy`**, which writes the real multi-version manifest. To preview multiple versions locally the same way as production, use **`mike serve`** after you have a `gh-pages` branch with deployed versions.

{openscvx-0.5.2.dev2/openscvx.egg-info → openscvx-2.dev1}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.4
 Name: openscvx
-Version: 0.5.2.dev2
+Version: 2.dev1
 Summary: A general Python-based successive convexification implementation which uses a JAX backend.
 Author-email: Chris Hayner and Griffin Norris <haynec@uw.edu>
 License: Apache Software License
-Project-URL: Homepage, https://openscvx.github.io/openscvx/
+Project-URL: Homepage, https://openscvx.github.io/OpenSCvx/
 Classifier: Programming Language :: Python :: 3
 Classifier: License :: OSI Approved :: Apache Software License
-Requires-Python: >=3.9
+Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: cvxpy>=1.8.1
@@ -23,12 +23,6 @@ Requires-Dist: viser
 Requires-Dist: matplotlib
 Requires-Dist: pyyaml
 Requires-Dist: pydantic>=2.0
-Provides-Extra: gui
-Requires-Dist: pyqtgraph; extra == "gui"
-Requires-Dist: PyQt5; extra == "gui"
-Requires-Dist: scipy; extra == "gui"
-Requires-Dist: PyOpenGL; extra == "gui"
-Requires-Dist: PyOpenGL_accelerate; extra == "gui"
 Provides-Extra: cvxpygen
 Requires-Dist: cvxpygen; extra == "cvxpygen"
 Requires-Dist: qocogen; extra == "cvxpygen"
@@ -156,11 +150,11 @@ uv pip install openscvx
 ```
 
 > [!TIP]
-> **Optional Dependencies**
+> **Optional dependencies**
 >
-> For GUI support or CVXPYGen code generation:
+> For CVXPYGen code generation:
 > ```bash
-> pip install openscvx[gui,cvxpygen]
+> pip install openscvx[cvxpygen]
 > ```
 
 > [!TIP]
@@ -210,13 +204,13 @@ uv pip install -e .
 > git submodule update --init third_party/mujoco_menagerie
 > ```
 
-## Getting Started
+## Documentation
 
-Check out the OpenSCvx documentation to help you get started
+Check out the OpenSCvx documentation:
 
-- [Getting Started Docs](https://openscvx.github.io/OpenSCvx/latest/getting-started/)
 - [Users Guide](https://openscvx.github.io/OpenSCvx/latest/UsersGuide/00_introduction/)
-- [API Reference](https://openscvx.github.io/OpenSCvx/latest/Reference/problem/)
+- [API Reference](https://openscvx.github.io/OpenSCvx/latest/Reference/)
+- [Examples overview](https://openscvx.github.io/OpenSCvx/latest/examples/)
 
 ### Running the Examples
 

{openscvx-0.5.2.dev2 → openscvx-2.dev1}/README.md

@@ -107,11 +107,11 @@ uv pip install openscvx
 ```
 
 > [!TIP]
-> **Optional Dependencies**
+> **Optional dependencies**
 >
-> For GUI support or CVXPYGen code generation:
+> For CVXPYGen code generation:
 > ```bash
-> pip install openscvx[gui,cvxpygen]
+> pip install openscvx[cvxpygen]
 > ```
 
 > [!TIP]
@@ -161,13 +161,13 @@ uv pip install -e .
 > git submodule update --init third_party/mujoco_menagerie
 > ```
 
-## Getting Started
+## Documentation
 
-Check out the OpenSCvx documentation to help you get started
+Check out the OpenSCvx documentation:
 
-- [Getting Started Docs](https://openscvx.github.io/OpenSCvx/latest/getting-started/)
 - [Users Guide](https://openscvx.github.io/OpenSCvx/latest/UsersGuide/00_introduction/)
-- [API Reference](https://openscvx.github.io/OpenSCvx/latest/Reference/problem/)
+- [API Reference](https://openscvx.github.io/OpenSCvx/latest/Reference/)
+- [Examples overview](https://openscvx.github.io/OpenSCvx/latest/examples/)
 
 ### Running the Examples