# Python API

This page is generated from docstrings by ``autodoc``, so it stays in sync with
the code automatically.  The compiled ``_solvcon`` extension is mocked during
the build (see `conf.py`), so these pages render even on a clean checkout where
the C++ layer has not been compiled.

Below is an example that documents the one-dimensional Euler solver.  Point
``automodule`` at any module to render its public surface.

```{eval-rst}
.. automodule:: solvcon.onedim.euler1d
   :members:
   :undoc-members:
   :show-inheritance:
```

<!-- vim: set ft=markdown ff=unix fenc=utf8 et sw=2 ts=2 sts=2 tw=79: -->