Project Documentation¶

This site provides project documentation. Use the documentation navigation to explore.

How-To Guide¶

Many instructions are common to all our projects.

See ⭐ Workflow: Apply Example to get these projects running on your machine.

Project Documentation Pages (docs/)¶

• Home - this documentation landing page
• Project Instructions - the standard project workflow
• Your Files - how to copy the example and create your version
• Glossary - project terms and concepts
• API - autogenerated code documentation for the public project interface

The API page is not always easy to read at first, but it becomes useful as you get more comfortable with project structure, modules, functions, and docstrings.