========
Examples
========

Real-world examples of documenting MATLAB code.

Complete Project Example
=========================

- Example project included in this site: :doc:`../api/index`. See ``/docs/api/``
  and ``/docs/src/`` in this repo for full source.
- Simple full project: "`simple site`_" "`simple site source`_".

.. _simple site: https://jasonnicholson.github.io/regularizeNd
.. _simple site source: https://github.com/jasonnicholson/regularizeNd/tree/main/docs

Function Examples
=================

Coming soon: Various function documentation patterns.

Class Examples
==============

Coming soon: Class documentation with inheritance.

Package Examples
================

Coming soon: Large package organization.

See Also
========

* :doc:`../getting-started/first-project` - Step-by-step tutorial
* :doc:`autodoc-directives` - Directive reference

.. note::
   This page is under development. Check back soon!