Kirill Simonov avatar Kirill Simonov committed 919afc9

Keep multiline HTSQL links in the documentation; updated module list in API reference.

Comments (0)

Files changed (11)

    :maxdepth: 2
 
    api/htsql
-   api/htsql.ctl
+   api/htsql.cmd
+   api/htsql.fmt
    api/htsql.tr
    api/htsql.tr.fn
-   api/htsql_pgsql
-   api/htsql_sqlite
-   api/htsql_mysql
+   api/htsql_ctl
 

doc/api/htsql.cmd.rst

+********************************
+  The :mod:`htsql.cmd` package
+********************************
+
+.. automodule:: htsql.cmd
+   :members:
+.. automodule:: htsql.cmd.act
+   :members:
+.. automodule:: htsql.cmd.command
+   :members:
+.. automodule:: htsql.cmd.retrieve
+   :members:
+

doc/api/htsql.ctl.rst

-********************************
-  The :mod:`htsql.ctl` package
-********************************
-
-.. automodule:: htsql.ctl
-   :members:
-.. automodule:: htsql.ctl.default
-   :members:
-.. automodule:: htsql.ctl.error
-   :members:
-.. automodule:: htsql.ctl.help
-   :members:
-.. automodule:: htsql.ctl.option
-   :members:
-.. automodule:: htsql.ctl.server
-   :members:
-.. automodule:: htsql.ctl.shell
-   :members:
-.. automodule:: htsql.ctl.regress
-   :members:
-.. automodule:: htsql.ctl.request
-   :members:
-.. automodule:: htsql.ctl.routine
-   :members:
-.. automodule:: htsql.ctl.script
-   :members:
-.. automodule:: htsql.ctl.version
-   :members:
-

doc/api/htsql.fmt.rst

+********************************
+  The :mod:`htsql.fmt` package
+********************************
+
+.. automodule:: htsql.fmt
+   :members:
+.. automodule:: htsql.fmt.entitle
+   :members:
+.. automodule:: htsql.fmt.format
+   :members:
+.. automodule:: htsql.fmt.html
+   :members:
+.. automodule:: htsql.fmt.json
+   :members:
+.. automodule:: htsql.fmt.spreadsheet
+   :members:
+.. automodule:: htsql.fmt.text
+   :members:
+

doc/api/htsql.rst

    :members:
 .. automodule:: htsql.error
    :members:
-.. automodule:: htsql.export
-   :members:
 .. automodule:: htsql.introspect
    :members:
 .. automodule:: htsql.mark
    :members:
+.. automodule:: htsql.request
+   :members:
 .. automodule:: htsql.split_sql
    :members:
 .. automodule:: htsql.util

doc/api/htsql.tr.fn.rst

 
 .. automodule:: htsql.tr.fn
    :members:
+.. automodule:: htsql.tr.fn.assemble
+   :members:
+.. automodule:: htsql.tr.fn.bind
+   :members:
+.. automodule:: htsql.tr.fn.dump
+   :members:
+.. automodule:: htsql.tr.fn.encode
+   :members:
+.. automodule:: htsql.tr.fn.reduce
+   :members:
+.. automodule:: htsql.tr.fn.rewrite
+   :members:
+.. automodule:: htsql.tr.fn.signature
+   :members:
 

doc/api/htsql_ctl.rst

+********************************
+  The :mod:`htsql_ctl` package
+********************************
+
+.. automodule:: htsql_ctl
+   :members:
+.. automodule:: htsql_ctl.default
+   :members:
+.. automodule:: htsql_ctl.error
+   :members:
+.. automodule:: htsql_ctl.extension
+   :members:
+.. automodule:: htsql_ctl.help
+   :members:
+.. automodule:: htsql_ctl.option
+   :members:
+.. automodule:: htsql_ctl.regress
+   :members:
+.. automodule:: htsql_ctl.request
+   :members:
+.. automodule:: htsql_ctl.routine
+   :members:
+.. automodule:: htsql_ctl.script
+   :members:
+.. automodule:: htsql_ctl.server
+   :members:
+.. automodule:: htsql_ctl.shell
+   :members:
+.. automodule:: htsql_ctl.version
+   :members:
+

doc/api/htsql_mysql.rst

-**********************************
-  The :mod:`htsql_mysql` package
-**********************************
-
-.. automodule:: htsql_mysql
-   :members:
-.. automodule:: htsql_mysql.connect
-   :members:
-.. automodule:: htsql_mysql.domain
-   :members:
-.. automodule:: htsql_mysql.export
-   :members:
-.. automodule:: htsql_mysql.introspect
-   :members:
-.. automodule:: htsql_mysql.split_sql
-   :members:
-

doc/api/htsql_pgsql.rst

-**********************************
-  The :mod:`htsql_pgsql` package
-**********************************
-
-.. automodule:: htsql_pgsql
-   :members:
-.. automodule:: htsql_pgsql.connect
-   :members:
-.. automodule:: htsql_pgsql.domain
-   :members:
-.. automodule:: htsql_pgsql.export
-   :members:
-.. automodule:: htsql_pgsql.introspect
-   :members:
-.. automodule:: htsql_pgsql.split_sql
-   :members:
-

doc/api/htsql_sqlite.rst

-***********************************
-  The :mod:`htsql_sqlite` package
-***********************************
-
-.. automodule:: htsql_sqlite
-   :members:
-.. automodule:: htsql_sqlite.connect
-   :members:
-.. automodule:: htsql_sqlite.domain
-   :members:
-.. automodule:: htsql_sqlite.export
-   :members:
-.. automodule:: htsql_sqlite.introspect
-   :members:
-.. automodule:: htsql_sqlite.split_sql
-   :members:
-

src/sphinxext_htsqldoc/__init__.py

                 return [doc.reporter.error("directive cannot have both"
                                            " content and an argument",
                                            lineno=self.lineno)]
-            query_content  = " ".join(line.strip()
-                                      for line in self.arguments[0].split("\n"))
-            query = query_content
+            query  = " ".join(line.strip()
+                              for line in self.arguments[0].split("\n"))
         elif self.content:
-            query_content = "\n".join(self.content).strip()
-            query =  " ".join(line.strip() for line in self.content)
+            query = "\n".join(self.content).strip()
         else:
             return [doc.reporter.error("directive must have either content"
                                        " or an argument", lineno=self.lineno)]
-        query_node = htsql_block(query_content, query_content)
+        query_node = htsql_block(query, query)
         query_node['language'] = 'htsql'
         if not hasattr(env, 'htsql_server') or not env.htsql_server:
             return [doc.reporter.error("config option `htsql_server`"
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.