lnav/docs/source/conf.py

# -*- coding: utf-8 -*-
#
# lnav documentation build configuration file, created by
# sphinx-quickstart on Fri Jul 12 21:09:39 2013.
#
# This file is execfile()d with the current directory set to its containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.

import sys, os

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.
this_dir = os.path.abspath('.')
src_dir = os.path.join(this_dir, "..", "..", "src")
sys.path.insert(0, this_dir)
sys.path.insert(0, src_dir)

import format2csv

format2csv.main(["",
                 os.path.join(this_dir, "format-table.csv"),
                 os.path.join(src_dir, "formats")])

import re
from pygments.lexer import RegexLexer, words
from pygments.token import Punctuation, Whitespace, Text, Comment, Operator, \
    Keyword, Name, String, Literal, Number, Generic
from sphinx.highlighting import lexers


class CustSqliteLexer(RegexLexer):
    name = 'custsqlite'

    flags = re.IGNORECASE
    tokens = {
        'root': [
            (r'\s+', Text),
            (r'--.*\n?', Comment.Single),
            (r'#.*\n?', Comment.Single),
            (r'/\*', Comment.Multiline, 'multiline-comments'),
            (words((
                'ABORT',
                'ACTION',
                'ADD',
                'AFTER',
                'ALL',
                'ALTER',
                'ALWAYS',
                'ANALYZE',
                'AND',
                'AS',
                'ASC',
                'ATTACH',
                'AUTOINCREMENT',
                'BEFORE',
                'BEGIN',
                'BETWEEN',
                'BY',
                'CASCADE',
                'CASE',
                'CAST',
                'CHECK',
                'COLLATE',
                'COLUMN',
                'COMMIT',
                'CONFLICT',
                'CONSTRAINT',
                'CREATE',
                'CROSS',
                'CURRENT',
                'CURRENT_DATE',
                'CURRENT_TIME',
                'CURRENT_TIMESTAMP',
                'DATABASE',
                'DEFAULT',
                'DEFERRABLE',
                'DEFERRED',
                'DELETE',
                'DESC',
                'DETACH',
                'DISTINCT',
                'DO',
                'DROP',
                'EACH',
                'ELSE',
                'END',
                'ESCAPE',
                'EXCEPT',
                'EXCLUDE',
                'EXCLUSIVE',
                'EXISTS',
                'EXPLAIN',
                'FAIL',
                'FILTER',
                'FIRST',
                'FOLLOWING',
                'FOR',
                'FOREIGN',
                'FROM',
                'FULL',
                'GENERATED',
                'GLOB',
                'GROUP',
                'GROUPS',
                'HAVING',
                'IF',
                'IGNORE',
                'IMMEDIATE',
                'IN',
                'INDEX',
                'INDEXED',
                'INITIALLY',
                'INNER',
                'INSERT',
                'INSTEAD',
                'INTERSECT',
                'INTO',
                'IS',
                'ISNULL',
                'JOIN',
                'KEY',
                'LAST',
                'LEFT',
                'LIKE',
                'LIMIT',
                'MATCH',
                'NATURAL',
                'NO',
                'NOT',
                'NOTHING',
                'NOTNULL',
                'NULL',
                'NULLS',
                'OF',
                'OFFSET',
                'ON',
                'OR',
                'ORDER',
                'OTHERS',
                'OUTER',
                'OVER',
                'PARTITION',
                'PLAN',
                'PRAGMA',
                'PRECEDING',
                'PRIMARY',
                'QUERY',
                'RAISE',
                'RANGE',
                'RECURSIVE',
                'REFERENCES',
                'REGEXP',
                'REINDEX',
                'RELEASE',
                'RENAME',
                'REPLACE',
                'RESTRICT',
                'RIGHT',
                'ROLLBACK',
                'ROW',
                'ROWS',
                'SAVEPOINT',
                'SELECT',
                'SET',
                'TABLE',
                'TEMP',
                'TEMPORARY',
                'THEN',
                'TIES',
                'TO',
                'TRANSACTION',
                'TRIGGER',
                'UNBOUNDED',
                'UNION',
                'UNIQUE',
                'UPDATE',
                'USING',
                'VACUUM',
                'VALUES',
                'VIEW',
                'VIRTUAL',
                'WHEN',
                'WHERE',
                'WINDOW',
                'WITH',
                'WITHOUT'), suffix=r'\b'),
             Keyword),
            (words((
                'ARRAY', 'BIGINT', 'BINARY', 'BIT', 'BLOB', 'BOOLEAN', 'CHAR',
                'CHARACTER', 'DATE', 'DEC', 'DECIMAL', 'FLOAT', 'INT', 'INTEGER',
                'INTERVAL', 'NUMBER', 'NUMERIC', 'REAL', 'SERIAL', 'SMALLINT',
                'VARCHAR', 'VARYING', 'INT8', 'SERIAL8', 'TEXT'), suffix=r'\b'),
             Name.Builtin),
            (r'[+*/<>=~!@#%^&|`?-]', Operator),
            (r'[0-9]+', Number.Integer),
            # TODO: Backslash escapes?
            (r"'(''|[^'])*'", String.Single),
            (r'"(""|[^"])*"', String.Symbol),  # not a real string literal in ANSI SQL
            (r'[a-z_][\w$]*', Name),  # allow $s in strings for Oracle
            (r'\$[a-z_]+', Name),
            (r'[;:()\[\],.]', Punctuation)
        ],
        'multiline-comments': [
            (r'/\*', Comment.Multiline, 'multiline-comments'),
            (r'\*/', Comment.Multiline, '#pop'),
            (r'[^/*]+', Comment.Multiline),
            (r'[/*]', Comment.Multiline)
        ]
    }

    def analyse_text(text):
        return 0.01


lexers['custsqlite'] = CustSqliteLexer(startinline=True)

# -- General configuration -----------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
# needs_sphinx = '1.0'

# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = [
    'sphinx.ext.coverage',
    'sphinx_copybutton',
    'sphinx-jsonschema',
    'sphinx-prompt',
    '_ext.lnavlexer',
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']

# The suffix of source filenames.
source_suffix = '.rst'

# The encoding of source files.
# source_encoding = 'utf-8-sig'

# The master toctree document.
master_doc = 'index'

# General information about the project.
project = u'lnav'
copyright = u'2023, Tim Stack'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '0.12'
# The full version, including alpha/beta/rc tags.
release = '0.12.0'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
# language = None

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
# today = ''
# Else, today_fmt is used as the format for a strftime call.
# today_fmt = '%B %d, %Y'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = []

# The reST default role (used for this markup: `text`) to use for all documents.
# default_role = None

# If true, '()' will be appended to :func: etc. cross-reference text.
# add_function_parentheses = True

# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
# add_module_names = True

# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
# show_authors = False

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'

# A list of ignored prefixes for module index sorting.
# modindex_common_prefix = []

# -- Options for HTML output ---------------------------------------------------

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
html_theme = 'furo'

# Theme options are theme-specific and customize the look and feel of a theme
# further.  For a list of options available for each theme, see the
# documentation.
html_theme_options = {
}

# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = []

# The name for this set of Sphinx documents.  If None, it defaults to
# "<project> v<release> documentation".
html_title = f"lnav v{release}"

# A shorter title for the navigation bar.  Default is the same as html_title.
# html_short_title = None

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
# html_logo = None

# The name of an image file (within the static path) to use as favicon of the
# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
# html_favicon = None

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['_static']


def setup(app):
    app.add_css_file('theme_overrides.css')


# html_context = {
#    'css_files': [
#        '_static/theme_overrides.css',  # override wide tables in RTD theme
#    ],
# }

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
# html_last_updated_fmt = '%b %d, %Y'

# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
# html_use_smartypants = True

# Custom sidebar templates, maps document names to template names.
# html_sidebars = {}

# Additional templates that should be rendered to pages, maps page names to
# template names.
# html_additional_pages = {}

# If false, no module index is generated.
# html_domain_indices = True

# If false, no index is generated.
# html_use_index = True

# If true, the index is split into individual pages for each letter.
# html_split_index = False

# If true, links to the reST sources are added to the pages.
# html_show_sourcelink = True

# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
# html_show_sphinx = True

# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
# html_show_copyright = True

# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it.  The value of this option must be the
# base URL from which the finished HTML is served.
# html_use_opensearch = ''

# This is the file name suffix for HTML files (e.g. ".xhtml").
# html_file_suffix = None

# Output file base name for HTML help builder.
htmlhelp_basename = 'lnavdoc'

# -- Options for LaTeX output --------------------------------------------------

latex_elements = {
    # The paper size ('letterpaper' or 'a4paper').
    # 'papersize': 'letterpaper',

    # The font size ('10pt', '11pt' or '12pt').
    # 'pointsize': '10pt',

    # Additional stuff for the LaTeX preamble.
    # 'preamble': '',
}

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
    ('index', 'lnav.tex', u'lnav Documentation',
     u'Tim Stack', 'manual'),
]

# The name of an image file (relative to this directory) to place at the top of
# the title page.
# latex_logo = None

# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
# latex_use_parts = False

# If true, show page references after internal links.
# latex_show_pagerefs = False

# If true, show URL addresses after external links.
# latex_show_urls = False

# Documents to append as an appendix to all manuals.
# latex_appendices = []

# If false, no module index is generated.
# latex_domain_indices = True


# -- Options for manual page output --------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    ('index', 'lnav', u'lnav Documentation',
     [u'Tim Stack'], 1)
]

# If true, show URL addresses after external links.
# man_show_urls = False


# -- Options for Texinfo output ------------------------------------------------

# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
#  dir menu entry, description, category)
texinfo_documents = [
    ('index', 'lnav', u'lnav Documentation',
     u'Tim Stack', 'lnav', 'One line description of project.',
     'Miscellaneous'),
]

# Documents to append as an appendix to all manuals.
# texinfo_appendices = []

# If false, no module index is generated.
# texinfo_domain_indices = True

# How to display URL addresses: 'footnote', 'no', or 'inline'.
# texinfo_show_urls = 'footnote'