-
Notifications
You must be signed in to change notification settings - Fork 37
Expand file tree
/
Copy pathconf.py
More file actions
124 lines (101 loc) · 3.88 KB
/
conf.py
File metadata and controls
124 lines (101 loc) · 3.88 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
116
117
118
119
120
121
122
123
124
# 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
import os
import sys
from datetime import datetime
# -- 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('.'))
sys.path.append(os.path.abspath("../"))
# -- Project information -----------------------------------------------------
project = "Documentation"
html_title = "Hypernode Documentation"
current_year = datetime.now().year
copyright = f"{current_year}, Hypernode"
author = "Hypernode"
# The full version, including alpha/beta/rc tags
release = "latest"
# -- General configuration ---------------------------------------------------
source_suffix = {
#'.rst': 'restructuredtext',
".md": "markdown",
#'.txt': 'markdown',
}
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
"myst_parser",
"sphinx_copybutton",
"notfound.extension",
"hypernode.sphinx.extensions.updated_at",
"hypernode.sphinx.extensions.meta_robots",
"hypernode.sphinx.extensions.github_actions_logging",
"sphinx_docsearch",
]
# 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.
#
html_theme = "sphinx_rtd_theme"
html_theme_options = {
"navigation_depth": 4,
"collapse_navigation": False,
"titles_only": False,
"analytics_id": "GTM-PDL826",
}
html_context = {
"display_github": True, # Integrate GitHub
"github_user": "ByteInternet", # Username
"github_repo": "hypernode-docs-next", # Repo name
"github_version": "master", # Version
"conf_py_path": "/docs/", # Path in the checkout to the docs root
}
html_show_sphinx = False
html_show_sourcelink = False
sitemap_url_scheme = "{link}"
if os.getenv("DOCS_INDEX_FOLLOW", 0):
html_meta_robots = "index, follow"
if os.getenv("DOCS_BASE_URL"):
html_baseurl = os.getenv("DOCS_BASE_URL")
# Only generate sitemap when we have a base url
extensions.extend(
[
"sphinx_sitemap",
"hypernode.sphinx.extensions.json_sitemap",
]
)
# 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_css_files = [
"https://fonts.googleapis.com/css?family=Montserrat:400,400i,500,600,700,800",
"https://fonts.googleapis.com/css?family=Open+Sans:400,400i,700",
"https://static.hypernode.com/fontawesome/css/fontawesome-all.css",
"https://static.hypernode.com/css/byteStyle.css",
"css/main.css",
]
html_js_files = ["js/app.js"]
highlight_options = {
"php": {"startinline": True}, # We often have php snippets without the <?php tag
}
notfound_urls_prefix = None
myst_heading_anchors = 5
docsearch_app_id = "ML4HHD5658"
docsearch_api_key = "03f6d3f4f55562ca202f03baeb04b350" # Public Search API Key
docsearch_index_name = "hypernode"