Developer Guide# Scarabaeus Coding Conventions Introduction General Rules Commenting Type-Hinting Naming Conventions Code Layout File Header Notes and To-Do’s Imports Generating Units Class Definition and Class Constants Initialization Properties Operator Overloading Methods Further Reading Scarabaeus External Resource Guide Introduction Documenting Scripts for the Library Reference General Docstring Rules Writing Descriptions Defining ArrayWUnits Class Docstring The Class Description The Parameters Section The Raises Section The See Also Section The Notes Section The References Section The Examples Section The Complete Class Docstring Property Docstrings Method Docstrings The Returns Section Further Reading Updating the External Resource Adding New Classes to the Sphinx Structure Make the Autodoc .rst File Add to the Toctree Building the HTML’s Final Checks Updating the Online Version Setup to Interface C++ with Python scripts Mac Setup Guide Windows Setup Guide
