Skip to content

Commit 49a15a0

Browse files
authored
Doc improvements before the release (#1553)
1 parent 459ef59 commit 49a15a0

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+108
-117
lines changed

doc/_static/custom.css

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,9 @@
2020
border: 0px;
2121
vertical-align: top;
2222
}
23+
24+
.getting-started-button {
25+
border-radius: 6px !important;
26+
padding: 0.7em 3em !important;
27+
font-size: 1.2em;
28+
}
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{# Added because of https://github.com/pydata/pydata-sphinx-theme/issues/2088 #}
2+
{# Displays a link to the .rst source of the current page. #}
3+
{% if show_source and has_source and sourcename %}
4+
<div class="tocsection sourcelink">
5+
<a href="{{ pathto('_sources/' + sourcename, true)|e }}">
6+
<i class="fa-solid fa-file-lines"></i> {{ _("Show Source") }}
7+
</a>
8+
</div>
9+
{% endif %}

doc/about.md

Lines changed: 1 addition & 1 deletion

doc/conf.py

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66

77
import os
88
import param
9+
import pydata_sphinx_theme
910

1011
param.parameterized.docstring_signature = False
1112
param.parameterized.docstring_describe_params = False
@@ -26,6 +27,10 @@
2627

2728
html_static_path += ['_static'] # noqa
2829

30+
if pydata_sphinx_theme.__version__ == '0.16.1':
31+
# See https://github.com/pydata/pydata-sphinx-theme/issues/2088
32+
templates_path.append('_static/patch_templates') # noqa
33+
2934
html_css_files += ['custom.css'] # noqa
3035

3136
html_js_files = [
@@ -34,6 +39,7 @@
3439

3540
html_theme_options.update( # noqa
3641
{
42+
'use_edit_page_button': True,
3743
'github_url': 'https://github.com/holoviz/hvplot',
3844
'icon_links': [
3945
{
@@ -57,6 +63,9 @@
5763
}
5864
)
5965

66+
# Without this .txt is appended to the files
67+
html_sourcelink_suffix = ''
68+
6069
html_theme = 'pydata_sphinx_theme'
6170
html_logo = '_static/logo_horizontal.svg'
6271
html_favicon = '_static/favicon.ico'
@@ -127,15 +136,23 @@
127136
'user_guide/pandas_api': 'ref/api_compatibility/pandas/pandas_api',
128137
}
129138

139+
html_extra_path = ['topics.html']
140+
130141
html_context.update( # noqa
131142
{
132143
'last_release': f'v{release}',
133-
'github_user': 'holoviz',
134-
'github_repo': 'panel',
135144
'default_mode': 'light',
145+
# Useful for the edit button
146+
'github_user': 'holoviz',
147+
'github_repo': 'hvplot',
148+
'github_version': 'main',
149+
'doc_path': 'doc',
136150
}
137151
)
138152

153+
# linkcheck
154+
linkcheck_ignore = [r'https://github.com/holoviz/hvplot/pull/\d+']
155+
139156
# mystnb
140157
nb_execution_excludepatterns = [
141158
'user_guide/Streaming.ipynb',

doc/developer_guide.md

Lines changed: 1 addition & 1 deletion

doc/index.md

Lines changed: 12 additions & 1 deletion

doc/ref/api/hvplot_api/hvplot.hvPlot.explorer.ipynb

Lines changed: 0 additions & 30 deletions
This file was deleted.

doc/ref/api/index.md

Lines changed: 32 additions & 33 deletions
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)