Add first version of developer docs

feder-observatory · Dec 13, 2023 · a86ec79 · a86ec79
1 parent c11cd69
commit a86ec79
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 4 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -9,7 +9,11 @@ This is a package for doing stellar photometry that relies on astropy.
 
   stellarphot/index.rst
 
-.. note:: The layout of this directory is simply a suggestion.  To follow
-          traditional practice, do *not* edit this page, but instead place
-          all documentation for the package inside ``stellarphot/``.
-          You can follow this practice or choose your own layout.
+
+Developer Documentation
+=======================
+
+.. toctree::
+   :maxdepth: 1
+
+   dev/index.rst
diff --git a/docs/stellarphot/index.rst b/docs/stellarphot/index.rst
@@ -27,6 +27,7 @@ Reference/API
 .. automodapi:: stellarphot.io
 .. automodapi:: stellarphot.photometry.photometry
 .. automodapi:: stellarphot.photometry.source_detection
+.. automodapi:: stellarphot.settings
 .. automodapi:: stellarphot.transit_fitting
 .. automodapi:: stellarphot.transit_fitting.gui
 .. automodapi:: stellarphot.transit_fitting.io

diff --git a/stellarphot/settings/autowidgets.py b/stellarphot/settings/autowidgets.py
@@ -3,8 +3,15 @@
 import ipywidgets as w
 from ipyautoui.autowidgets import create_widget_caller
 
+__all__ = [
+    'CustomBoundedIntTex'
+]
+
 
 class CustomBoundedIntTex(w.BoundedIntText):
+    """
+    A BoundedIntText widget adapted for use in ipyautoui.
+    """
     def __init__(self, schema):
         self.schema = schema
         self.caller = create_widget_caller(schema)

diff --git a/stellarphot/settings/views.py b/stellarphot/settings/views.py
@@ -4,4 +4,7 @@
 
 
 def ui_generator(model):
+    """
+    Silly function to generate an AutoUi object from a model.
+    """
     return AutoUi(model)