clipkit: clipkit_repo/docs/conf.py comparison

comparison clipkit_repo/docs/conf.py @ 0:49b058e85902 draft

"planemo upload for repository https://github.com/jlsteenwyk/clipkit commit cbe1e8577ecb1a46709034a40dff36052e876e7a-dirty"

author	padge
date	Fri, 25 Mar 2022 13:04:31 +0000
parents
children

comparison

equal deleted inserted replaced

--1:000000000000
+:49b058e85902
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+import os
+import sys
+from collections import OrderedDict
+# -- Path setup --------------------------------------------------------------
+# 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.
+#
+# sys.path.append(os.path.abspath('_themes'))
+sys.path.append(os.path.abspath("./_ext"))
+# -- Project information -----------------------------------------------------
+project = "clipkit"
+copyright = "2020 Jacob L. Steenwyk"
+author = "Jacob L. Steenwyk <jlsteenwyk@gmail.com>"
+# The short X.Y version
+# version = "0.0.1"
+# The full version, including alpha/beta/rc tags
+# release = "0.0.1-alpha"
+# -- 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.githubpages"]
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ["_templates"]
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = ".rst"
+# The master toctree document.
+master_doc = "index"
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path.
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store", "_ext"]
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = None
+# -- Options for HTML output -------------------------------------------------
+# Favicon
+html_favicon = "_static/img/flavicon.png"
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = "sphinx_rtd_theme"
+# 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 = {
+"body_max_width": "900px",
+'logo_only': True,
+'analytics_id': 'UA-104875636-1'
+}
+html_logo = '_static/img/ClipKIT_logo_top_only_v1.png'
+html_show_sourcelink = False
+# 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"]
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+html_sidebars = {
+"**": [
+"sidebar-top.html",
+"navigation.html",
+"relations.html",  # needs 'show_related': True theme option to display
+"searchbox.html",
+]
+}
+# -- Options for HTMLHelp output ---------------------------------------------
+# Output file base name for HTML help builder.
+htmlhelp_basename = "clipkitdoc"
+# -- 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': '',
+# Latex figure (float) alignment
+#
+# 'figure_align': 'htbp',
+}
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+(
+master_doc,
+"clipkit.tex",
+"clipkit Documentation",
+"Jacob L. Steenwyk \\textless{}jlsteenwyk@gmail.com\\textgreater{}",
+"manual",
+),
+]
+# -- Options for manual page output ------------------------------------------
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [(master_doc, "clipkit", "clipkit Documentation", [author], 1)]
+# -- 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 = [
+(
+master_doc,
+"clipkit",
+"clipkit Documentation",
+author,
+"clipkit",
+"A data transformation engine.",
+"Miscellaneous",
+),
+]
+# -- Options for Epub output -------------------------------------------------
+# Bibliographic Dublin Core info.
+epub_title = project
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#
+# epub_identifier = ''
+# A unique identification for the text.
+#
+# epub_uid = ''
+# A list of files that should not be packed into the epub file.
+epub_exclude_files = ["search.html"]
+# -- Setup -------------------------------------------------
+def setup(app):
+app.add_css_file("custom.css")

Mercurial > repos > padge > clipkit

comparison clipkit_repo/docs/conf.py @ 0:49b058e85902 draft