openscvx 0.3.2.dev127__tar.gz → 0.3.2.dev129__tar.gz

{openscvx-0.3.2.dev127 → openscvx-0.3.2.dev129}/CONTRIBUTING.md

@@ -178,3 +178,36 @@ While we do not strictly follow [test driven development (TDD)](https://en.wikip
 For example, the [symbolic-expression layer](openscvx/symbolic/__init__.py) is well covered by [tests](tests/symbolic/) which were written simultaneously with the symbolic layer.
 
 The extensive test suite helps ensure that new features and refactors don't break existing functionality.
+
+#### Documentation
+
+We use [MkDocs](https://www.mkdocs.org/) with [Material](https://squidfunk.github.io/mkdocs-material/) theme for documentation, hosted at [haynec.github.io/OpenSCvx](https://haynec.github.io/OpenSCvx/).
+
+API reference is auto-generated from docstrings using [mkdocstrings](https://mkdocstrings.github.io/). Please use [Google-style docstrings](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) for all public functions and classes:
+
+```python
+def solve(self, max_iterations: int = 100) -> OptimizationResult:
+    """Solve the trajectory optimization problem.
+
+    Args:
+        max_iterations: Maximum number of SCP iterations.
+
+    Returns:
+        The optimization result containing the trajectory and convergence info.
+
+    Raises:
+        ConvergenceError: If the solver fails to converge.
+    """
+```
+
+To preview documentation locally, first install the dependencies:
+
+```bash
+pip install mkdocs-material mkdocstrings-python mkdocs-gen-files mkdocs-literate-nav mkdocs-section-index
+```
+
+Then serve the documentation locally:
+
+```bash
+mkdocs serve
+```

{openscvx-0.3.2.dev127/openscvx.egg-info → openscvx-0.3.2.dev129}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: openscvx
-Version: 0.3.2.dev127
+Version: 0.3.2.dev129
 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

{openscvx-0.3.2.dev127 → openscvx-0.3.2.dev129}/openscvx/_version.py

@@ -28,7 +28,7 @@ version_tuple: VERSION_TUPLE
 commit_id: COMMIT_ID
 __commit_id__: COMMIT_ID
 
-__version__ = version = '0.3.2.dev127'
-__version_tuple__ = version_tuple = (0, 3, 2, 'dev127')
+__version__ = version = '0.3.2.dev129'
+__version_tuple__ = version_tuple = (0, 3, 2, 'dev129')
 
-__commit_id__ = commit_id = 'g580ea58cc'
+__commit_id__ = commit_id = 'g24aff8688'

{openscvx-0.3.2.dev127 → openscvx-0.3.2.dev129/openscvx.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: openscvx
-Version: 0.3.2.dev127
+Version: 0.3.2.dev129
 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