summaryrefslogtreecommitdiffstats
path: root/docs/source
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2021-09-06 04:12:52 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2021-09-06 04:12:52 +0000
commitf42dcf1d6578df945fb52fb24703e88de54ad45b (patch)
treeefd58347c05908c103cfdf8a2b3321c158a7e360 /docs/source
parentAdding upstream version 2.1.0. (diff)
downloadcli-helpers-f42dcf1d6578df945fb52fb24703e88de54ad45b.tar.xz
cli-helpers-f42dcf1d6578df945fb52fb24703e88de54ad45b.zip
Adding upstream version 2.2.0.upstream/2.2.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'docs/source')
-rw-r--r--docs/source/conf.py114
-rw-r--r--docs/source/quickstart.rst2
2 files changed, 59 insertions, 57 deletions
diff --git a/docs/source/conf.py b/docs/source/conf.py
index 4944893..cf99ea6 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -19,8 +19,10 @@
#
import ast
from collections import OrderedDict
+
# import os
import re
+
# import sys
# sys.path.insert(0, os.path.abspath('.'))
@@ -34,22 +36,18 @@ import re
# 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.autodoc',
- 'sphinx.ext.intersphinx',
- 'sphinx.ext.viewcode'
-]
+extensions = ["sphinx.ext.autodoc", "sphinx.ext.intersphinx", "sphinx.ext.viewcode"]
# Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
html_sidebars = {
- '**': [
- 'about.html',
- 'navigation.html',
- 'relations.html',
- 'searchbox.html',
- 'donate.html',
+ "**": [
+ "about.html",
+ "navigation.html",
+ "relations.html",
+ "searchbox.html",
+ "donate.html",
]
}
@@ -57,25 +55,26 @@ html_sidebars = {
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
-source_suffix = '.rst'
+source_suffix = ".rst"
# The master toctree document.
-master_doc = 'index'
+master_doc = "index"
# General information about the project.
-project = 'CLI Helpers'
-author = 'dbcli'
-description = 'Python helpers for common CLI tasks'
-copyright = '2017, dbcli'
+project = "CLI Helpers"
+author = "dbcli"
+description = "Python helpers for common CLI tasks"
+copyright = "2017, dbcli"
# 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.
#
-_version_re = re.compile(r'__version__\s+=\s+(.*)')
-with open('../../cli_helpers/__init__.py', 'rb') as f:
- version = str(ast.literal_eval(_version_re.search(
- f.read().decode('utf-8')).group(1)))
+_version_re = re.compile(r"__version__\s+=\s+(.*)")
+with open("../../cli_helpers/__init__.py", "rb") as f:
+ version = str(
+ ast.literal_eval(_version_re.search(f.read().decode("utf-8")).group(1))
+ )
# The full version, including alpha/beta/rc tags.
release = version
@@ -93,7 +92,7 @@ language = None
exclude_patterns = []
# The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = False
@@ -104,40 +103,42 @@ todo_include_todos = False
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
-html_theme = 'alabaster'
+html_theme = "alabaster"
# 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.
-nav_links = OrderedDict((
- ('CLI Helpers at GitHub', 'https://github.com/dbcli/cli_helpers'),
- ('CLI Helpers at PyPI', 'https://pypi.org/project/cli_helpers'),
- ('Issue Tracker', 'https://github.com/dbcli/cli_helpers/issues')
-))
+nav_links = OrderedDict(
+ (
+ ("CLI Helpers at GitHub", "https://github.com/dbcli/cli_helpers"),
+ ("CLI Helpers at PyPI", "https://pypi.org/project/cli_helpers"),
+ ("Issue Tracker", "https://github.com/dbcli/cli_helpers/issues"),
+ )
+)
html_theme_options = {
- 'description': description,
- 'github_user': 'dbcli',
- 'github_repo': 'cli_helpers',
- 'github_banner': False,
- 'github_button': False,
- 'github_type': 'watch',
- 'github_count': False,
- 'extra_nav_links': nav_links
+ "description": description,
+ "github_user": "dbcli",
+ "github_repo": "cli_helpers",
+ "github_banner": False,
+ "github_button": False,
+ "github_type": "watch",
+ "github_count": False,
+ "extra_nav_links": nav_links,
}
# 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']
+html_static_path = ["_static"]
# -- Options for HTMLHelp output ------------------------------------------
# Output file base name for HTML help builder.
-htmlhelp_basename = 'CLIHelpersdoc'
+htmlhelp_basename = "CLIHelpersdoc"
# -- Options for LaTeX output ---------------------------------------------
@@ -146,15 +147,12 @@ 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': '',
-
# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
@@ -164,8 +162,7 @@ latex_elements = {
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
- (master_doc, 'CLIHelpers.tex', 'CLI Helpers Documentation',
- 'dbcli', 'manual'),
+ (master_doc, "CLIHelpers.tex", "CLI Helpers Documentation", "dbcli", "manual"),
]
@@ -173,10 +170,7 @@ latex_documents = [
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
-man_pages = [
- (master_doc, 'clihelpers', 'CLI Helpers Documentation',
- [author], 1)
-]
+man_pages = [(master_doc, "clihelpers", "CLI Helpers Documentation", [author], 1)]
# -- Options for Texinfo output -------------------------------------------
@@ -185,16 +179,24 @@ man_pages = [
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
- (master_doc, 'CLIHelpers', 'CLI Helpers Documentation',
- author, 'CLIHelpers', description,
- 'Miscellaneous'),
+ (
+ master_doc,
+ "CLIHelpers",
+ "CLI Helpers Documentation",
+ author,
+ "CLIHelpers",
+ description,
+ "Miscellaneous",
+ ),
]
intersphinx_mapping = {
- 'python': ('https://docs.python.org/3', None),
- 'py2': ('https://docs.python.org/2', None),
- 'pymysql': ('https://pymysql.readthedocs.io/en/latest/', None),
- 'numpy': ('https://docs.scipy.org/doc/numpy', None),
- 'configobj': ('https://configobj.readthedocs.io/en/latest', None)
+ "python": ("https://docs.python.org/3", None),
+ "py2": ("https://docs.python.org/2", None),
+ "pymysql": ("https://pymysql.readthedocs.io/en/latest/", None),
+ "numpy": ("https://docs.scipy.org/doc/numpy", None),
+ "configobj": ("https://configobj.readthedocs.io/en/latest", None),
}
+
+linkcheck_ignore = ["https://github.com/psf/black.*"]
diff --git a/docs/source/quickstart.rst b/docs/source/quickstart.rst
index 0cbd45b..319655d 100644
--- a/docs/source/quickstart.rst
+++ b/docs/source/quickstart.rst
@@ -50,7 +50,7 @@ Let's get a list of all the supported format names::
>>> from cli_helpers.tabular_output import TabularOutputFormatter
>>> formatter = TabularOutputFormatter()
>>> formatter.supported_formats
- ('vertical', 'csv', 'tsv', 'mediawiki', 'html', 'latex', 'latex_booktabs', 'textile', 'moinmoin', 'jira', 'plain', 'simple', 'grid', 'fancy_grid', 'pipe', 'orgtbl', 'psql', 'rst', 'ascii', 'double', 'github')
+ ('vertical', 'csv', 'tsv', 'mediawiki', 'html', 'latex', 'latex_booktabs', 'textile', 'moinmoin', 'jira', 'plain', 'minimal', 'simple', 'grid', 'fancy_grid', 'pipe', 'orgtbl', 'psql', 'psql_unicode', 'rst', 'ascii', 'double', 'github')
You can format your data in any of those supported formats. Let's take the
same data from our first example and put it in the ``fancy_grid`` format::