##// END OF EJS Templates
docs(build): updated docs build image and templates
super-admin -
Show More
@@ -0,0 +1,34 b''
1 {#-
2
3 Hi there!
4
5 You might be interested in https://pradyunsg.me/furo/customisation/sidebar/
6
7 Although if you're reading this, chances are that you're either familiar
8 enough with Sphinx that you know what you're doing, or landed here from that
9 documentation page.
10
11 Hope your day's going well. :)
12
13 -#}
14 <a class="sidebar-brand{% if logo %} centered{% endif %}" href="{{ pathto(master_doc) }}">
15 {% block brand_content %}
16 {%- if logo_url %}
17 <div class="sidebar-logo-container">
18 <img class="sidebar-logo" src="{{ logo_url }}" alt="Logo"/>
19 </div>
20 {%- endif %}
21 {%- if theme_light_logo and theme_dark_logo %}
22 <div class="sidebar-logo-container">
23 <img class="sidebar-logo only-light" src="{{ pathto('_static/' + theme_light_logo, 1) }}" alt="Light Logo"/>
24 <img class="sidebar-logo only-dark" src="{{ pathto('_static/' + theme_dark_logo, 1) }}" alt="Dark Logo"/>
25 </div>
26 {%- endif %}
27 {% if not theme_sidebar_hide_name %}
28 <span class="sidebar-brand-text">
29 RhodeCode <br/>
30 rcstack {{ release }} docs
31 </span>
32 {%- endif %}
33 {% endblock brand_content %}
34 </a> No newline at end of file
@@ -1,6 +1,7 b''
1 ## BUILD Image for building docs
1 ## BUILD Image for building docs and push to rhodecode registry
2 2 # cd docs
3 3 # docker build --tag rhodecode/sphinx-doc-build .
4 # docker push rhodecode/sphinx-doc-build
4 5
5 6 # Build Docs
6 7 # run from the project root dir; not docs dir
@@ -1,11 +1,11 b''
1 1 sphinx==7.2.6
2 2
3 furo==2023.9.10
3 furo==2024.1.29
4 4 sphinx-press-theme==0.8.0
5 5 sphinx-rtd-theme==1.3.0
6 6
7 pygments==2.16.1
7 pygments==2.17.2
8 8
9 9 docutils<0.19
10 markupsafe==2.1.3
11 jinja2==3.1.2
10 markupsafe==2.1.4
11 jinja2==3.1.3
@@ -13,6 +13,12 b''
13 13 <div class="visually-hidden">Hide table of contents sidebar</div>
14 14 </label>
15 15
16 <a class="skip-to-content muted-link" href="#furo-main-content">
17 {%- trans -%}
18 Skip to content
19 {%- endtrans -%}
20 </a>
21
16 22 {% if theme_announcement -%}
17 23 <div class="announcement">
18 24 <aside class="announcement-content">
@@ -87,7 +93,7 b''
87 93 <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
88 94 </label>
89 95 </div>
90 <article role="main">
96 <article role="main" id="furo-main-content">
91 97 {% block content %}{{ body }}{% endblock %}
92 98 </article>
93 99 </div>
@@ -141,6 +147,9 b''
141 147 {% trans %}<a href="https://www.sphinx-doc.org/">Sphinx</a> and {% endtrans -%}
142 148 <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
143 149 {% endif -%}
150
151
152
144 153 {%- if last_updated -%}
145 154 <div class="last-updated">
146 155 {% trans last_updated=last_updated|e -%}
@@ -149,7 +158,7 b''
149 158 </div>
150 159
151 160 <div style="border-top: 0">
152 Got documentation defects and suggestions? <a href="https://community.rhodecode.com">Submit docs issues</a>
161 Got documentation defects and suggestions? <a href="https://community.rhodecode.com/new-topic?title=documentation%20issue&body=Please%20describe%20the%20issue&category=support&tags=docs-issue">Submit docs issues</a>
153 162 </div>
154 163
155 164 {%- endif %}
@@ -172,6 +181,9 b''
172 181 </svg>
173 182 </a>
174 183 {%- endif -%}
184 {#- Show GitHub repository home -#}
185 {%- if READTHEDOCS and display_github and github_user != "None" and github_repo != "None" -%}
186 {%- endif -%}
175 187 {%- endif %}
176 188 </div>
177 189 {%- endif %}
@@ -200,5 +212,4 b''
200 212 </aside>
201 213 </div>
202 214 </div>
203
204 215 {%- endblock %}
General Comments 0
You need to be logged in to leave comments. Login now