Skip to content

Commit 7f7e538

Browse files
author
Gerit Wagner
committed
docs: api
1 parent 072a705 commit 7f7e538

File tree

56 files changed

+1360
-29
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

56 files changed

+1360
-29
lines changed

‎docs/source/conf.py‎

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
import datetime
2+
import os
3+
import sys
24

35
# Configuration file for the Sphinx documentation builder.
46
#
@@ -7,6 +9,8 @@
79
# -- Project information -----------------------------------------------------
810
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
911

12+
sys.path.insert(0, os.path.abspath(".."))
13+
1014
project = "Search Query"
1115
current_year = datetime.datetime.now().year
1216
copyright = f"{current_year}, Gerit Wagner"
@@ -16,12 +20,24 @@
1620
# -- General configuration ---------------------------------------------------
1721
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
1822

19-
extensions = ["sphinx_copybutton", "sphinxcontrib.datatemplates"]
23+
extensions = [
24+
"sphinx_copybutton",
25+
"sphinxcontrib.datatemplates",
26+
"sphinx.ext.autodoc",
27+
"sphinx.ext.autosummary",
28+
]
2029

2130
templates_path = ["_templates"]
2231
exclude_patterns = []
2332

2433

34+
autosummary_generate = True
35+
autodoc_default_options = {
36+
"members": True,
37+
"undoc-members": True,
38+
"show-inheritance": True,
39+
}
40+
2541
# -- Options for HTML output -------------------------------------------------
2642
# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
2743

‎docs/source/dev_docs/_autosummary/search_query.cli.rst‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
search\_query.cli
2+
=================
3+
4+
.. automodule:: search_query.cli
5+
6+
7+
8+
9+
10+
11+
12+
.. rubric:: Functions
13+
14+
.. autosummary::
15+
16+
lint
17+
translate

‎docs/source/dev_docs/_autosummary/search_query.constants.rst‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
search\_query.constants
2+
=======================
3+
4+
.. automodule:: search_query.constants
5+
6+
7+
8+
9+
10+
11+
12+
13+
14+
15+
16+
.. rubric:: Classes
17+
18+
.. autosummary::
19+
20+
Colors
21+
ExitCodes
22+
Fields
23+
LinterMode
24+
ListToken
25+
ListTokenTypes
26+
OperatorNodeTokenTypes
27+
Operators
28+
PLATFORM
29+
QueryErrorCode
30+
Token
31+
TokenTypes

‎docs/source/dev_docs/_autosummary/search_query.database.rst‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
search\_query.database
2+
======================
3+
4+
.. automodule:: search_query.database
5+
6+
7+
8+
9+
10+
11+
12+
.. rubric:: Functions
13+
14+
.. autosummary::
15+
16+
list_queries
17+
list_queries_with_details
18+
load_query

‎docs/source/dev_docs/_autosummary/search_query.database_queries.rst‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
search\_query.database\_queries
2+
===============================
3+
4+
.. automodule:: search_query.database_queries

‎docs/source/dev_docs/_autosummary/search_query.ebsco.constants.rst‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
search\_query.ebsco.constants
2+
=============================
3+
4+
.. automodule:: search_query.ebsco.constants
5+
6+
7+
8+
9+
10+
11+
12+
.. rubric:: Functions
13+
14+
.. autosummary::
15+
16+
generic_search_field_to_syntax_field
17+
map_to_standard
18+
syntax_str_to_generic_search_field_set

‎docs/source/dev_docs/_autosummary/search_query.ebsco.linter.rst‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
search\_query.ebsco.linter
2+
==========================
3+
4+
.. automodule:: search_query.ebsco.linter
5+
6+
7+
8+
9+
10+
11+
12+
13+
14+
15+
16+
.. rubric:: Classes
17+
18+
.. autosummary::
19+
20+
EBSCOQueryStringLinter

‎docs/source/dev_docs/_autosummary/search_query.ebsco.parser.rst‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
search\_query.ebsco.parser
2+
==========================
3+
4+
.. automodule:: search_query.ebsco.parser
5+
6+
7+
8+
9+
10+
11+
12+
13+
14+
15+
16+
.. rubric:: Classes
17+
18+
.. autosummary::
19+
20+
EBSCOListParser
21+
EBSCOParser

‎docs/source/dev_docs/_autosummary/search_query.ebsco.rst‎

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
search\_query.ebsco
2+
===================
3+
4+
.. automodule:: search_query.ebsco
5+
6+
7+
8+
9+
10+
11+
12+
13+
14+
15+
16+
17+
18+
19+
20+
21+
22+
23+
24+
.. rubric:: Modules
25+
26+
.. autosummary::
27+
:toctree:
28+
:recursive:
29+
30+
search_query.ebsco.constants
31+
search_query.ebsco.linter
32+
search_query.ebsco.parser
33+
search_query.ebsco.serializer
34+
search_query.ebsco.translator

‎docs/source/dev_docs/_autosummary/search_query.ebsco.serializer.rst‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
search\_query.ebsco.serializer
2+
==============================
3+
4+
.. automodule:: search_query.ebsco.serializer
5+
6+
7+
8+
9+
10+
11+
12+
.. rubric:: Functions
13+
14+
.. autosummary::
15+
16+
to_string_ebsco

0 commit comments

Comments
 (0)