Browse Source

Adding sphinx documentation

Matt Sparks 13 years ago
parent
commit
543a9063a4
14 changed files with 113 additions and 0 deletions
  1. 6 0
      docs/charsets.rst
  2. 6 0
      docs/colors.rst
  3. 7 0
      docs/counters.rst
  4. 6 0
      docs/date.rst
  5. 6 0
      docs/extchars.rst
  6. 33 0
      docs/index.rst
  7. 8 0
      docs/interfaces.rst
  8. 6 0
      docs/modes.rst
  9. 5 0
      docs/packet.rst
  10. 6 0
      docs/positions.rst
  11. 6 0
      docs/speeds.rst
  12. 6 0
      docs/string.rst
  13. 6 0
      docs/text.rst
  14. 6 0
      docs/time.rst

+ 6 - 0
docs/charsets.rst

@@ -0,0 +1,6 @@
+Character sets
+==============
+
+.. automodule:: alphasign.charsets
+  :members:
+

+ 6 - 0
docs/colors.rst

@@ -0,0 +1,6 @@
+Colors
+======
+
+.. automodule:: alphasign.colors
+  :members:
+

+ 7 - 0
docs/counters.rst

@@ -0,0 +1,7 @@
+Modes
+=====
+
+.. automodule:: alphasign.modes
+  :members:
+  :undoc-members:
+

+ 6 - 0
docs/date.rst

@@ -0,0 +1,6 @@
+Date access
+===========
+
+.. automodule:: alphasign.date
+  :members:
+

+ 6 - 0
docs/extchars.rst

@@ -0,0 +1,6 @@
+Extended characters
+===================
+
+.. automodule:: alphasign.extchars
+  :members:
+

+ 33 - 0
docs/index.rst

@@ -0,0 +1,33 @@
+alphasign API
+=============
+
+The alphasign package is a Python API for the
+`Alpha Communications Protocol <http://www.alpha-american.com/p-alpha-communications-protocol.html>`_.
+
+.. automodule:: alphasign
+  :members:
+
+.. toctree::
+  :maxdepth: 2
+
+  charsets
+  colors
+  counters
+  date
+  extchars
+  modes
+  packet
+  positions
+  speeds
+  string
+  text
+  time
+  interfaces
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+

+ 8 - 0
docs/interfaces.rst

@@ -0,0 +1,8 @@
+Interfaces
+==========
+
+.. automodule:: alphasign.interfaces.base
+  :members:
+
+.. automodule:: alphasign.interfaces.local
+  :members:

+ 6 - 0
docs/modes.rst

@@ -0,0 +1,6 @@
+Display modes
+=============
+
+.. automodule:: alphasign.modes
+  :members:
+

+ 5 - 0
docs/packet.rst

@@ -0,0 +1,5 @@
+Packet
+======
+
+.. automodule:: alphasign.packet
+  :members:

+ 6 - 0
docs/positions.rst

@@ -0,0 +1,6 @@
+Display positions
+=================
+
+.. automodule:: alphasign.positions
+  :members:
+

+ 6 - 0
docs/speeds.rst

@@ -0,0 +1,6 @@
+Speeds
+======
+
+.. automodule:: alphasign.speeds
+  :members:
+

+ 6 - 0
docs/string.rst

@@ -0,0 +1,6 @@
+STRING files
+============
+
+.. automodule:: alphasign.string
+  :members:
+

+ 6 - 0
docs/text.rst

@@ -0,0 +1,6 @@
+TEXT files
+==========
+
+.. automodule:: alphasign.text
+  :members:
+

+ 6 - 0
docs/time.rst

@@ -0,0 +1,6 @@
+Time access
+===========
+
+.. automodule:: alphasign.time
+  :members:
+