Commit eba5af4e authored by michal's avatar michal
Browse files

[feat] Docs.

parent 2a9e7bb0

Makefile

+1 −0
Original line number Diff line number Diff line
@@ -21,6 +21,7 @@ help: 
.PHONY: help docs docstring pypi install test analysis clean tox



docs:

	# note that line 42 in stdlib/sets might cause an error (unknown bug), it is enough to replace the definition with {"0"}

	$(PY) -m pip install -r $(SPHINX_TARGET)/$(REQ_FILE)

	$(SPHINXBUILD) -c $(SPHINX_TARGET)/ -b html $(SPHINX_TARGET) $(SPHINX_TARGET)/html $(SPHINXOPTS)

README.md

+1 −1
Original line number Diff line number Diff line
@@ -43,7 +43,7 @@ It is still possible to start your bot directly from python[^example], e.g. 
    >>> my_bot = Bot()

    >>> my_bot.learn_aiml("path to .aiml file")

    >>> # more loading stuff, see `pyaiml21.utils` for helpers

    >>> my_bot.respond("USER_1", "Hello")

    >>> my_bot.respond("Hello", "USER_1")

    Hi! How are you doing?

doc/_templates/class-template.rst

+2 −2
Original line number Diff line number Diff line
@@ -3,13 +3,13 @@ 


{{ fullname | escape | underline}}



    CLASS TEMPLATE



.. currentmodule:: {{ module }}



.. autoclass:: {{ objname }}

   :members:

   :show-inheritance:

   :inherited-members:

   :special-members: __call__, __add__, __mul__



   {% block methods %}

   {% if methods %}

doc/api.rst

deleted100644 → 0
+0 −43
Original line number Diff line number Diff line 
.. _api:



.. autosummary::

   :toctree: _autosummary

   :template: module-template.rst

   :recursive:



   pyaiml21



API reference

=============



GraphMaster

-----------



.. autoclass:: pyaiml21.graphmaster.GraphMaster

   :members:

   :inherited-members:



MongoGraphMaster

^^^^^^^^^^^^^^^^



.. autoclass:: pyaiml21.graphmaster.MongoGraphMaster

   :members:

   :inherited-members:





SqLiteGraphMaster

^^^^^^^^^^^^^^^^^



.. autoclass:: pyaiml21.graphmaster.SqLiteGraphMaster

   :members:

   :inherited-members:





Bot

---



.. autoclass:: pyaiml21.bot

   :members:

   :inherited-members:



TODO
 
 No newline at end of file

doc/examples.rst

deleted100644 → 0
+0 −4
Original line number Diff line number Diff line 
Examples

========



TBD.
 
 No newline at end of file