Skip to content

Allow to generate docs for embed and use locally in mattermost #7844

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Allow to generate docs for embed and use locally in mattermost #7844

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2be76bd
Allow to generate docs for embed and use locally in mattermost
jespino Apr 4, 2025
e09f26b
Merge branch 'master' into localdocs
cwarnermm May 15, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions source/_static/css/homepage-v1.css
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 11 additions & 0 deletions source/_static/scss/homepage-v1.scss
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,27 @@ body {
.sidebar-sticky {
padding-top: 120px;
}
.sidebar-sticky-local {
padding-top: 0;
}

.masthead {
padding-top: 160px;
&.masthead-local {
padding-top: 0;
}
}

.sidebar-sticky {
@media (max-width: 770px) {
padding-top: 110px;
}
}
.sidebar-sticky-local {
@media (max-width: 770px) {
padding-top: 0;
}
}

.mobile-header {
top: -15px;
Expand Down
8 changes: 5 additions & 3 deletions source/_templates/custom-index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,9 @@
<div class="visually-hidden">Hide table of contents sidebar</div>
</label>

{% include "custom-nav.html" %}
{% if webdocs %}
{% include "custom-nav.html" %}
{% endif %}

{% if theme_announcement -%}
<div class="announcement">
Expand Down Expand Up @@ -80,7 +82,7 @@
<aside class="sidebar-drawer">
<div class="sidebar-container">
{% block left_sidebar %}
<div class="sidebar-sticky">
<div class="{% if webdocs %}sidebar-sticky{% else %}sidebar-sticky-local{% endif %}">
{%- for sidebar_section in sidebars %}
{%- include sidebar_section %}
{%- endfor %}
Expand Down Expand Up @@ -121,7 +123,7 @@
</label>
</div>
<article role="main">
<section class="masthead">
<section class="{% if webdocs %}masthead{% else %}masthead masthead-local{% endif %}">
<div class="container">
<div class="theme-toggle-container theme-toggle-header">
<button class="theme-toggle">
Expand Down
9 changes: 7 additions & 2 deletions source/_templates/page-v1.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@
<div class="visually-hidden">Hide table of contents sidebar</div>
</label>

{% include "custom-nav.html" %}
{% if webdocs %}
{% include "custom-nav.html" %}
{% endif %}

{% if theme_announcement -%}
<div class="announcement">
Expand Down Expand Up @@ -65,7 +67,8 @@
<aside class="sidebar-drawer">
<div class="sidebar-container">
{% block left_sidebar %}
<div class="sidebar-sticky">
<div class="{% if webdocs %}sidebar-sticky{% else %}sidebar-sticky-local{% endif %}">

{%- for sidebar_section in sidebars %}
{%- include sidebar_section %}
{%- endfor %}
Expand Down Expand Up @@ -115,7 +118,9 @@
{% block content %}{{ body }}{% endblock %}
</article>
</div>
{% if webdocs %}
<div class="docs-feedback-block">{% include "feedback.html" %}</div>
{% endif %}
<footer>
{% block footer %}
<div class="related-pages">
Expand Down
12 changes: 8 additions & 4 deletions source/_templates/page.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,17 @@
{{ super() }}
{% endblock extrahead %}
{% block footer -%}
<div class="docs-feedback-block">
{% include "feedback.html" %}
</div>
{% if webdocs %}
<div class="docs-feedback-block">
{% include "feedback.html" %}
</div>
{%endif %}
{{ super() }}
{% endblock footer %}
{% block body -%}
{% include "google-tag-manager-noscript.html" %}
{% include "custom-nav.html" %}
{% if webdocs %}
{% include "custom-nav.html" %}
{%endif %}
{{ super() }}
{% endblock body %}
1 change: 1 addition & 0 deletions source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4081,6 +4081,7 @@ def setup(_: Sphinx):
# Enable Google Analytics
"googleanalytics_id": "UA-67846571-2",
"googleanalytics_enabled": True,
"webdocs": "LOCAL_DOCS" not in os.environ,
}

# The theme to use for HTML and HTML Help pages. See the documentation for
Expand Down