Skip to content

Commit

Permalink
Updating docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mbodenhamer committed Feb 12, 2017
1 parent 75269e7 commit 3ac7396
Show file tree
Hide file tree
Showing 10 changed files with 163 additions and 11 deletions.
4 changes: 2 additions & 2 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Changelog
---------

0.0.12 (2016-09-05)
~~~~~~~~~~~~~~~~~~~
0.0.12 (2017-02-12)
~~~~~~~~~~~~~~~~~~
- Added iteration methods to syn.tree.b.Node
- Added syn.tree.query
- Added syn.types
Expand Down
2 changes: 1 addition & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ syn

``syn`` is a Python library and command-line tool that will provide metaprogramming, typing, and compilation facilities.

This project is currently in pre-alpha. Initial usage documentation and examples will be provided when the project moves to alpha in release ``0.1.0``. The target date for ``0.1.0`` is Q1 2017.
This project is currently in pre-alpha. Initial usage documentation and examples will be provided when the project moves to alpha in release ``0.1.0``. The target date for ``0.1.0`` is Q3 2017.
16 changes: 16 additions & 0 deletions docs/syn.base_utils.rst
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,14 @@ syn.base_utils.hash module
:undoc-members:
:show-inheritance:

syn.base_utils.iter module
--------------------------

.. automodule:: syn.base_utils.iter
:members:
:undoc-members:
:show-inheritance:

syn.base_utils.list module
--------------------------

Expand Down Expand Up @@ -84,6 +92,14 @@ syn.base_utils.rand module
:undoc-members:
:show-inheritance:

syn.base_utils.repl module
--------------------------

.. automodule:: syn.base_utils.repl
:members:
:undoc-members:
:show-inheritance:

syn.base_utils.str module
-------------------------

Expand Down
8 changes: 8 additions & 0 deletions docs/syn.conf.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,14 @@ syn.conf.conf module
:undoc-members:
:show-inheritance:

syn.conf.conf2 module
---------------------

.. automodule:: syn.conf.conf2
:members:
:undoc-members:
:show-inheritance:

syn.conf.vars module
--------------------

Expand Down
30 changes: 30 additions & 0 deletions docs/syn.globals.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
syn.globals package
===================

Submodules
----------

syn.globals.loggers module
--------------------------

.. automodule:: syn.globals.loggers
:members:
:undoc-members:
:show-inheritance:

syn.globals.values module
-------------------------

.. automodule:: syn.globals.values
:members:
:undoc-members:
:show-inheritance:


Module contents
---------------

.. automodule:: syn.globals
:members:
:undoc-members:
:show-inheritance:
2 changes: 2 additions & 0 deletions docs/syn.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,14 @@ Subpackages
syn.conf
syn.cython
syn.five
syn.globals
syn.python
syn.schema
syn.serialize
syn.sets
syn.tree
syn.type
syn.types

Module contents
---------------
Expand Down
8 changes: 8 additions & 0 deletions docs/syn.tree.b.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,14 @@ syn.tree.b.node module
:undoc-members:
:show-inheritance:

syn.tree.b.query module
-----------------------

.. automodule:: syn.tree.b.query
:members:
:undoc-members:
:show-inheritance:

syn.tree.b.tree module
----------------------

Expand Down
8 changes: 0 additions & 8 deletions docs/syn.type.a.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,6 @@ syn.type.a.ext module
:undoc-members:
:show-inheritance:

syn.type.a.registry module
--------------------------

.. automodule:: syn.type.a.registry
:members:
:undoc-members:
:show-inheritance:

syn.type.a.type module
----------------------

Expand Down
78 changes: 78 additions & 0 deletions docs/syn.types.a.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
syn.types.a package
===================

Submodules
----------

syn.types.a.base module
-----------------------

.. automodule:: syn.types.a.base
:members:
:undoc-members:
:show-inheritance:

syn.types.a.mapping module
--------------------------

.. automodule:: syn.types.a.mapping
:members:
:undoc-members:
:show-inheritance:

syn.types.a.ne module
---------------------

.. automodule:: syn.types.a.ne
:members:
:undoc-members:
:show-inheritance:

syn.types.a.numeric module
--------------------------

.. automodule:: syn.types.a.numeric
:members:
:undoc-members:
:show-inheritance:

syn.types.a.sequence module
---------------------------

.. automodule:: syn.types.a.sequence
:members:
:undoc-members:
:show-inheritance:

syn.types.a.set module
----------------------

.. automodule:: syn.types.a.set
:members:
:undoc-members:
:show-inheritance:

syn.types.a.special module
--------------------------

.. automodule:: syn.types.a.special
:members:
:undoc-members:
:show-inheritance:

syn.types.a.string module
-------------------------

.. automodule:: syn.types.a.string
:members:
:undoc-members:
:show-inheritance:


Module contents
---------------

.. automodule:: syn.types.a
:members:
:undoc-members:
:show-inheritance:
18 changes: 18 additions & 0 deletions docs/syn.types.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
syn.types package
=================

Subpackages
-----------

.. toctree::

syn.types.a
syn.types.d

Module contents
---------------

.. automodule:: syn.types
:members:
:undoc-members:
:show-inheritance:

0 comments on commit 3ac7396

Please sign in to comment.