[doc] integrate the result of sphinx-apidoc on the rql module
authorLaurent Peuch <cortex@worlddomination.be>
Fri, 13 Dec 2019 05:36:22 +0100
changeset 878 a55f15c5693b
parent 877 d11f34623673
child 879 ad238b4d3e9a
[doc] integrate the result of sphinx-apidoc on the rql module
docs/index.txt
docs/rql.rst
--- a/docs/index.txt	Thu Dec 12 03:35:59 2019 +0100
+++ b/docs/index.txt	Fri Dec 13 05:36:22 2019 +0100
@@ -14,6 +14,8 @@
    canonisation.txt
    tutoriel_fr.txt
 
+   rql
+
 Indices and tables
 ==================
 
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/docs/rql.rst	Fri Dec 13 05:36:22 2019 +0100
@@ -0,0 +1,126 @@
+rql package
+===========
+
+Submodules
+----------
+
+rql.analyze module
+------------------
+
+.. automodule:: rql.analyze
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+rql.base module
+---------------
+
+.. automodule:: rql.base
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+rql.compare module
+------------------
+
+.. automodule:: rql.compare
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+rql.editextensions module
+-------------------------
+
+.. automodule:: rql.editextensions
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+rql.interfaces module
+---------------------
+
+.. automodule:: rql.interfaces
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+rql.nodes module
+----------------
+
+.. automodule:: rql.nodes
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+rql.parser module
+-----------------
+
+.. automodule:: rql.parser
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+rql.parser\_main module
+-----------------------
+
+.. automodule:: rql.parser_main
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+rql.pygments\_ext module
+------------------------
+
+.. automodule:: rql.pygments_ext
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+rql.rqlgen module
+-----------------
+
+.. automodule:: rql.rqlgen
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+rql.stcheck module
+------------------
+
+.. automodule:: rql.stcheck
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+rql.stmts module
+----------------
+
+.. automodule:: rql.stmts
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+rql.undo module
+---------------
+
+.. automodule:: rql.undo
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+rql.utils module
+----------------
+
+.. automodule:: rql.utils
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+
+Module contents
+---------------
+
+.. automodule:: rql
+    :members:
+    :undoc-members:
+    :show-inheritance: