This repository was archived by the owner on Jan 22, 2026. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathconf.py
More file actions
115 lines (90 loc) · 3.71 KB
/
conf.py
File metadata and controls
115 lines (90 loc) · 3.71 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
# Configuration file for the Sphinx documentation builder.
#
# This file only contains a selection of the most common options. For a full
# list see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html
# -- 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.
#
# import os
# import sys
# sys.path.insert(0, os.path.abspath('.'))
# -- Project information -----------------------------------------------------
project = 'falmeida-py'
copyright = '2020, Felipe, Almeida. falmeida-py: A simple package to index my frequently used python scripts.'
author = 'Felipe Marques de Almeida'
# -- General configuration ---------------------------------------------------
# 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'
# 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.intersphinx",
"sphinx.ext.autodoc",
"sphinx.ext.mathjax",
"sphinx.ext.viewcode",
"sphinx_copybutton"
]
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
# 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']
# -- Options for HTML output -------------------------------------------------
# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
# --- default ---
#import sphinx_rtd_theme
#html_theme = 'sphinx_rtd_theme'
# --- material ---
#import sphinx_materialdesign_theme
#html_theme = "sphinx_materialdesign_theme"
# --- jupyter ---
#import jupyter_sphinx_theme
#html_theme = "jupyter"
#html_sidebars = {'**': ['sidebartoc.html']}
#html_theme_path = jupyter_sphinx_theme.get_html_theme_path()
# --- karma ---
#html_theme = "karma_sphinx_theme"
# --- material ---
html_theme = "sphinx_material"
# Material theme options (see theme.conf for more information)
html_theme_options = {
# Set the color and the accent color
# Primary color. Options are red, pink, purple, deep-purple, indigo, blue, light-blue, cyan, teal, green, light-green, lime, yellow, amber, orange, deep-orange, brown, grey, blue-grey, and white.
'color_primary': 'indigo',
#Accent color. Options are red, pink, purple, deep-purple, indigo, blue, light-blue, cyan, teal, green, light-green, lime, yellow, amber, orange, and deep-orange.
'color_accent': 'amber',
# Visible levels of the global TOC; -1 means unlimited
'globaltoc_depth': 1,
# If False, expand all TOC entries
'globaltoc_collapse': True,
# If True, show hidden TOC entries
'globaltoc_includehidden': True,
# logo
'logo_icon': "book",
# repo info
"repo_url": "https://github.com/fmalmeida/pythonScripts",
"repo_name": "falmeida-py",
"repo_type": "github",
}
html_sidebars = {
"**": ["globaltoc.html", "localtoc.html", "searchbox.html"]
}
# --- custom css ---
html_title = project
html_static_path = ['_static']
html_css_files = ['style.css']
# Copy button configuration --------------------------------------------------
# Source: https://sphinx-copybutton.readthedocs.io/en/latest/
#copybutton_prompt_text = "$ "