-
-
Notifications
You must be signed in to change notification settings - Fork 35
/
conf.py
132 lines (125 loc) · 3.71 KB
/
conf.py
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
125
126
127
128
129
130
131
132
import sys
from pathlib import Path
from urllib.request import urlretrieve
sys.path.append(Path("exts").absolute().as_posix())
extensions = [
"myst_parser",
"nbsphinx",
"rawfiles",
"sphinx.ext.githubpages",
"sphinx.ext.intersphinx",
"sphinx.ext.mathjax",
"sphinxext.opengraph",
"ablog",
"sphinx_design",
"sphinx_reredirects",
"sphinxcontrib.youtube",
"sunpy_sphinx_theme.cards",
]
myst_enable_extensions = ["colon_fence"]
myst_update_mathjax = False
templates_path = ["_templates"]
intersphinx_mapping = {
"python": ("https://docs.python.org/3", None),
"sunpy": ("https://docs.sunpy.org/en/stable", None),
"astropy": ("https://docs.astropy.org/en/stable", None),
"ndcube": ("https://docs.sunpy.org/projects/ndcube/en/stable", None),
"drms": ("https://docs.sunpy.org/projects/drms/en/stable/", None),
"aiapy": ("https://aiapy.readthedocs.io/en/stable/", None),
}
rawfiles = ["meeting.html", "issues.html", "chat.html"]
mathjax_path = "https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/MathJax.js?config=TeX-MML-AM_CHTML"
blog_baseurl = "https://sunpy.org/"
blog_feed_fulltext = True
blog_feed_length = 10
blog_feed_archives = True
source_suffix = {
".rst": "restructuredtext",
".md": "markdown",
}
exclude_patterns = [
"posts/*/.ipynb_checkpoints/*",
".github/*",
".history/*",
"github_submodule/*",
"LICENSE.md",
"README.md",
"_build/*",
"CITATION.rst",
".tox/*",
]
master_doc = "index"
project = "sunpy.org"
author = "The SunPy Community"
copyright = "The SunPy Community" # NOQA: A001
show_sphinx = True
version = ""
release = "main"
language = "en"
pygments_style = "sphinx"
default_role = "obj"
html_theme = "sunpy"
html_title = "sunpy.org"
html_static_path = ["_static"]
html_extra_path = ["_static/img"]
html_theme_options = {
"show_prev_next": False,
"sst_is_root": True,
}
html_css_files = [
"sunpy_org.css",
]
blog_sidebars = [
"ablog/postcard.html",
"ablog/recentposts.html",
"ablog/tagcloud.html",
"ablog/categories.html",
"ablog/archives.html",
]
html_sidebars = {
"*": [],
"about": ["about-sidebar.html"],
"coc": ["about-sidebar.html"],
"about/**": ["about-sidebar.html"],
"posts/**": ["ablog/postcard.html"],
"blog": blog_sidebars,
"blog/**": blog_sidebars,
}
redirects = {
"project/meetings": "about/meetings",
"project/roles": "about/roles",
"project": "about/project",
"project/affiliated": "affiliated",
}
# nbsphinx options
nbsphinx_prolog = r"""
{% set docname = env.doc2path(env.docname, base=None) %}
.. only:: html
.. role:: raw-html(raw)
:format: html
.. nbinfo::
This blog post was written in a `Jupyter notebook`__.
Click here for an interactive version:
:raw-html:`<a href="https://mybinder.org/v2/gh/sunpy/sunpy.org/{{ env.config.release }}?filepath={{ docname }}"><img alt="Binder badge" src="https://mybinder.org/badge.svg" style="vertical-align:text-bottom"></a>`
__ https://github.com/sunpy/sunpy.org/blob/{{ env.config.release }}/{{ docname }}
"""
# sphinxext-opengraph
ogp_site_url = "https://sunpy.org/"
ogp_image = "https://raw.githubusercontent.com/sunpy/sunpy-logo/master/generated/sunpy_logo_word.png"
ogp_description_length = 300
ogp_type = "website"
urlretrieve(
"https://raw.githubusercontent.com/sunpy/sunpy/main/sunpy/CITATION.rst",
filename="CITATION.rst",
)
# These links have anchors that linkcheck does not like
linkcheck_ignore = [
"https://app.element.io/#/room/#sunpy:openastronomy.org",
]
linkcheck_anchors_ignore = [
r"/projects\?project=develop_sunkit-image",
"the-executive",
"acceptance-process-for-affiliated-packages",
"detailed-description",
"!forum/sunpy",
]