##// END OF EJS Templates
rhodecode-enterprise-ce
RSS
feat(docs): new docs build logic...
super-admin -
r5193:1e179e1f default
parent child Browse files
Show More
Show file before | Show file after | Hide comments
@@ -0,0 +1,5 b''
1 FROM sphinxdoc/sphinx
2
3 WORKDIR /project
4 ADD requirements_docs.txt /project
5 RUN pip3 install -r requirements_docs.txt
Show file before | Show file after | Hide comments
@@ -0,0 +1,117 b''
1 <!doctype html>
2 <html class="no-js"{% if language is not none %} lang="{{ language }}"{% endif %} data-content_root="{{ content_root }}">
3 <head>
4 <!-- Google Tag Manager -->
5 <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
6 new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
7 j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
8 'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
9 })(window,document,'script','dataLayer','GTM-M2TSG36B');</script>
10 <!-- End Google Tag Manager -->
11
12 {%- block site_meta -%}
13 <meta charset="utf-8"/>
14 <meta name="viewport" content="width=device-width,initial-scale=1"/>
15 <meta name="color-scheme" content="light dark">
16
17 {%- if metatags %}{{ metatags }}{% endif -%}
18
19 {%- block linktags %}
20 {%- if hasdoc('about') -%}
21 <link rel="author" title="{{ _('About these documents') }}" href="{{ pathto('about') }}" />
22 {%- endif -%}
23 {%- if hasdoc('genindex') -%}
24 <link rel="index" title="{{ _('Index') }}" href="{{ pathto('genindex') }}" />
25 {%- endif -%}
26 {%- if hasdoc('search') -%}
27 <link rel="search" title="{{ _('Search') }}" href="{{ pathto('search') }}" />
28 {%- endif -%}
29 {%- if hasdoc('copyright') -%}
30 <link rel="copyright" title="{{ _('Copyright') }}" href="{{ pathto('copyright') }}" />
31 {%- endif -%}
32 {%- if next -%}
33 <link rel="next" title="{{ next.title|striptags|e }}" href="{{ next.link|e }}" />
34 {%- endif -%}
35 {%- if prev -%}
36 <link rel="prev" title="{{ prev.title|striptags|e }}" href="{{ prev.link|e }}" />
37 {%- endif -%}
38 {#- rel="canonical" (set by html_baseurl) -#}
39 {%- if pageurl %}
40 <link rel="canonical" href="{{ pageurl|e }}" />
41 {%- endif %}
42 {%- endblock linktags %}
43
44 {# Favicon #}
45 {%- if favicon_url -%}
46 <link rel="shortcut icon" href="{{ favicon_url }}"/>
47 {%- endif -%}
48
49 <!-- Generated with Sphinx {{ sphinx_version }} and Furo {{ furo_version }} -->
50
51 {%- endblock site_meta -%}
52
53 {#- Site title -#}
54 {%- block htmltitle -%}
55 {% if not docstitle %}
56 <title>{{ title|striptags|e }}</title>
57 {% elif pagename == master_doc %}
58 <title>{{ docstitle|striptags|e }}</title>
59 {% else %}
60 <title>{{ title|striptags|e }} - {{ docstitle|striptags|e }}</title>
61 {% endif %}
62 {%- endblock -%}
63
64 {%- block styles -%}
65
66 {# Custom stylesheets #}
67 {%- block regular_styles -%}
68 {%- for css in css_files -%}
69 {% if css|attr("filename") -%}
70 {{ css_tag(css) }}
71 {%- else -%}
72 <link rel="stylesheet" href="{{ pathto(css, 1)|e }}" type="text/css" />
73 {%- endif %}
74 {% endfor -%}
75 {%- endblock regular_styles -%}
76
77 {#- Theme-related stylesheets -#}
78 {%- block theme_styles %}
79 {% include "partials/_head_css_variables.html" with context %}
80 {%- endblock -%}
81
82 {%- block extra_styles %}
83 {%- endblock -%}
84
85 {%- endblock styles -%}
86
87 {#- Custom front matter #}
88 {%- block extrahead -%}{%- endblock -%}
89 </head>
90 <body>
91 <!-- Google Tag Manager (noscript) -->
92 <noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-M2TSG36B"
93 height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript>
94 <!-- End Google Tag Manager (noscript) -->
95
96 {% block body %}
97 <script>
98 document.body.dataset.theme = localStorage.getItem("theme") || "auto";
99 </script>
100 {% endblock %}
101
102 {%- block scripts -%}
103
104 {# Custom JS #}
105 {%- block regular_scripts -%}
106 {% for path in script_files -%}
107 {{ js_tag(path) }}
108 {% endfor -%}
109 {%- endblock regular_scripts -%}
110
111 {# Theme-related JavaScript code #}
112 {%- block theme_scripts -%}
113 {%- endblock -%}
114
115 {%- endblock scripts -%}
116 </body>
117 </html> No newline at end of file
Show file before | Show file after | Hide comments
@@ -0,0 +1,204 b''
1 {% extends "base.html" %}
2
3 {% block body -%}
4 {{ super() }}
5 {% include "partials/icons.html" %}
6
7 <input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
8 <input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
9 <label class="overlay sidebar-overlay" for="__navigation">
10 <div class="visually-hidden">Hide navigation sidebar</div>
11 </label>
12 <label class="overlay toc-overlay" for="__toc">
13 <div class="visually-hidden">Hide table of contents sidebar</div>
14 </label>
15
16 {% if theme_announcement -%}
17 <div class="announcement">
18 <aside class="announcement-content">
19 {% block announcement %} {{ theme_announcement }} {% endblock announcement %}
20 </aside>
21 </div>
22 {%- endif %}
23
24 <div class="page">
25 <header class="mobile-header">
26 <div class="header-left">
27 <label class="nav-overlay-icon" for="__navigation">
28 <div class="visually-hidden">Toggle site navigation sidebar</div>
29 <i class="icon"><svg><use href="#svg-menu"></use></svg></i>
30 </label>
31 </div>
32 <div class="header-center">
33 <a href="{{ pathto(master_doc) }}"><div class="brand">{{ docstitle if docstitle else project }}</div></a>
34 </div>
35 <div class="header-right">
36 <div class="theme-toggle-container theme-toggle-header">
37 <button class="theme-toggle">
38 <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
39 <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
40 <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
41 <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
42 </button>
43 </div>
44 <label class="toc-overlay-icon toc-header-icon{% if furo_hide_toc %} no-toc{% endif %}" for="__toc">
45 <div class="visually-hidden">Toggle table of contents sidebar</div>
46 <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
47 </label>
48 </div>
49 </header>
50 <aside class="sidebar-drawer">
51 <div class="sidebar-container">
52 {% block left_sidebar %}
53 <div class="sidebar-sticky">
54 {%- for sidebar_section in sidebars %}
55 {%- include sidebar_section %}
56 {%- endfor %}
57 </div>
58 {% endblock left_sidebar %}
59 </div>
60 </aside>
61 <div class="main">
62 <div class="content">
63 <div class="article-container">
64 <a href="#" class="back-to-top muted-link">
65 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
66 <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
67 </svg>
68 <span>{% trans %}Back to top{% endtrans %}</span>
69 </a>
70 <div class="content-icon-container">
71 {% if theme_top_of_page_button == "edit" -%}
72 {%- include "components/edit-this-page.html" with context -%}
73 {%- elif theme_top_of_page_button != None -%}
74 {{ warning("Got an unsupported value for 'top_of_page_button'") }}
75 {%- endif -%}
76 {#- Theme toggle -#}
77 <div class="theme-toggle-container theme-toggle-content">
78 <button class="theme-toggle">
79 <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
80 <svg class="theme-icon-when-auto"><use href="#svg-sun-half"></use></svg>
81 <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
82 <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
83 </button>
84 </div>
85 <label class="toc-overlay-icon toc-content-icon{% if furo_hide_toc %} no-toc{% endif %}" for="__toc">
86 <div class="visually-hidden">Toggle table of contents sidebar</div>
87 <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
88 </label>
89 </div>
90 <article role="main">
91 {% block content %}{{ body }}{% endblock %}
92 </article>
93 </div>
94 <footer>
95 {% block footer %}
96 <div class="related-pages">
97 {% if next -%}
98 <a class="next-page" href="{{ next.link }}">
99 <div class="page-info">
100 <div class="context">
101 <span>{{ _("Next") }}</span>
102 </div>
103 <div class="title">{{ next.title }}</div>
104 </div>
105 <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
106 </a>
107 {%- endif %}
108 {% if prev -%}
109 <a class="prev-page" href="{{ prev.link }}">
110 <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
111 <div class="page-info">
112 <div class="context">
113 <span>{{ _("Previous") }}</span>
114 </div>
115 {% if prev.link == pathto(master_doc) %}
116 <div class="title">{{ _("Home") }}</div>
117 {% else %}
118 <div class="title">{{ prev.title }}</div>
119 {% endif %}
120 </div>
121 </a>
122 {%- endif %}
123 </div>
124 <div class="bottom-of-page">
125 <div class="left-details">
126 {%- if show_copyright %}
127 <div class="copyright">
128 {%- if hasdoc('copyright') %}
129 {% trans path=pathto('copyright'), copyright=copyright|e -%}
130 <a href="{{ path }}">Copyright</a> &#169; {{ copyright }}
131 {%- endtrans %}
132 {%- else %}
133 {% trans copyright=copyright|e -%}
134 Copyright &#169; {{ copyright }}
135 {%- endtrans %}
136 {%- endif %}
137 </div>
138 {%- endif %}
139
140 {%- if show_sphinx -%}
141 {% trans %}<a href="https://www.sphinx-doc.org/">Sphinx</a> and {% endtrans -%}
142 <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
143 {% endif -%}
144 {%- if last_updated -%}
145 <div class="last-updated">
146 {% trans last_updated=last_updated|e -%}
147 Last updated on {{ last_updated }}
148 {%- endtrans -%}
149 </div>
150
151 <div style="border-top: 0">
152 Got documentation defects and suggestions? <a href="https://community.rhodecode.com">Submit docs issues</a>
153 </div>
154
155 {%- endif %}
156 </div>
157 <div class="right-details">
158 {% if theme_footer_icons or READTHEDOCS -%}
159 <div class="icons">
160 {% if theme_footer_icons -%}
161 {% for icon_dict in theme_footer_icons -%}
162 <a class="muted-link {{ icon_dict.class }}" href="{{ icon_dict.url }}" aria-label="{{ icon_dict.name }}">
163 {{- icon_dict.html -}}
164 </a>
165 {% endfor %}
166 {%- else -%}
167 {#- Show Read the Docs project -#}
168 {%- if READTHEDOCS and slug -%}
169 <a class="muted-link" href="https://readthedocs.org/projects/{{ slug }}" aria-label="On Read the Docs">
170 <svg x="0px" y="0px" viewBox="-125 217 360 360" xml:space="preserve">
171 <path fill="currentColor" d="M39.2,391.3c-4.2,0.6-7.1,4.4-6.5,8.5c0.4,3,2.6,5.5,5.5,6.3 c0,0,18.5,6.1,50,8.7c25.3,2.1,54-1.8,54-1.8c4.2-0.1,7.5-3.6,7.4-7.8c-0.1-4.2-3.6-7.5-7.8-7.4c-0.5,0-1,0.1-1.5,0.2 c0,0-28.1,3.5-50.9,1.6c-30.1-2.4-46.5-7.9-46.5-7.9C41.7,391.3,40.4,391.1,39.2,391.3z M39.2,353.6c-4.2,0.6-7.1,4.4-6.5,8.5 c0.4,3,2.6,5.5,5.5,6.3c0,0,18.5,6.1,50,8.7c25.3,2.1,54-1.8,54-1.8c4.2-0.1,7.5-3.6,7.4-7.8c-0.1-4.2-3.6-7.5-7.8-7.4 c-0.5,0-1,0.1-1.5,0.2c0,0-28.1,3.5-50.9,1.6c-30.1-2.4-46.5-7.9-46.5-7.9C41.7,353.6,40.4,353.4,39.2,353.6z M39.2,315.9 c-4.2,0.6-7.1,4.4-6.5,8.5c0.4,3,2.6,5.5,5.5,6.3c0,0,18.5,6.1,50,8.7c25.3,2.1,54-1.8,54-1.8c4.2-0.1,7.5-3.6,7.4-7.8 c-0.1-4.2-3.6-7.5-7.8-7.4c-0.5,0-1,0.1-1.5,0.2c0,0-28.1,3.5-50.9,1.6c-30.1-2.4-46.5-7.9-46.5-7.9 C41.7,315.9,40.4,315.8,39.2,315.9z M39.2,278.3c-4.2,0.6-7.1,4.4-6.5,8.5c0.4,3,2.6,5.5,5.5,6.3c0,0,18.5,6.1,50,8.7 c25.3,2.1,54-1.8,54-1.8c4.2-0.1,7.5-3.6,7.4-7.8c-0.1-4.2-3.6-7.5-7.8-7.4c-0.5,0-1,0.1-1.5,0.2c0,0-28.1,3.5-50.9,1.6 c-30.1-2.4-46.5-7.9-46.5-7.9C41.7,278.2,40.4,278.1,39.2,278.3z M-13.6,238.5c-39.6,0.3-54.3,12.5-54.3,12.5v295.7 c0,0,14.4-12.4,60.8-10.5s55.9,18.2,112.9,19.3s71.3-8.8,71.3-8.8l0.8-301.4c0,0-25.6,7.3-75.6,7.7c-49.9,0.4-61.9-12.7-107.7-14.2 C-8.2,238.6-10.9,238.5-13.6,238.5z M19.5,257.8c0,0,24,7.9,68.3,10.1c37.5,1.9,75-3.7,75-3.7v267.9c0,0-19,10-66.5,6.6 C59.5,536.1,19,522.1,19,522.1L19.5,257.8z M-3.6,264.8c4.2,0,7.7,3.4,7.7,7.7c0,4.2-3.4,7.7-7.7,7.7c0,0-12.4,0.1-20,0.8 c-12.7,1.3-21.4,5.9-21.4,5.9c-3.7,2-8.4,0.5-10.3-3.2c-2-3.7-0.5-8.4,3.2-10.3c0,0,0,0,0,0c0,0,11.3-6,27-7.5 C-16,264.9-3.6,264.8-3.6,264.8z M-11,302.6c4.2-0.1,7.4,0,7.4,0c4.2,0.5,7.2,4.3,6.7,8.5c-0.4,3.5-3.2,6.3-6.7,6.7 c0,0-12.4,0.1-20,0.8c-12.7,1.3-21.4,5.9-21.4,5.9c-3.7,2-8.4,0.5-10.3-3.2c-2-3.7-0.5-8.4,3.2-10.3c0,0,11.3-6,27-7.5 C-20.5,302.9-15.2,302.7-11,302.6z M-3.6,340.2c4.2,0,7.7,3.4,7.7,7.7s-3.4,7.7-7.7,7.7c0,0-12.4-0.1-20,0.7 c-12.7,1.3-21.4,5.9-21.4,5.9c-3.7,2-8.4,0.5-10.3-3.2c-2-3.7-0.5-8.4,3.2-10.3c0,0,11.3-6,27-7.5C-16,340.1-3.6,340.2-3.6,340.2z" />
172 </svg>
173 </a>
174 {%- endif -%}
175 {%- endif %}
176 </div>
177 {%- endif %}
178 </div>
179 </div>
180 {% endblock footer %}
181 </footer>
182 </div>
183 <aside class="toc-drawer{% if furo_hide_toc %} no-toc{% endif %}">
184 {% block right_sidebar %}
185 {% if not furo_hide_toc %}
186 <div class="toc-sticky toc-scroll">
187 <div class="toc-title-container">
188 <span class="toc-title">
189 {{ _("On this page") }}
190 </span>
191 </div>
192 <div class="toc-tree-container">
193 <div class="toc-tree">
194 {{ toc }}
195 </div>
196 </div>
197 </div>
198 {% endif %}
199 {% endblock right_sidebar %}
200 </aside>
201 </div>
202 </div>
203
204 {%- endblock %}
Show file before | Show file after | Hide comments
@@ -69,19 +69,19 b' ruff-check:'
69 .PHONY: docs
69 .PHONY: docs
70 ## build docs
70 ## build docs
71 docs:
71 docs:
72 (cd docs; nix-build default.nix -o result; make clean html)
72 (cd docs; docker run --rm -v $(PWD):/project --workdir=/project/docs sphinx-doc-build-rc make clean html)
73
73
74
74
75 .PHONY: docs-clean
75 .PHONY: docs-clean
76 ## Cleanup docs
76 ## Cleanup docs
77 docs-clean:
77 docs-clean:
78 (cd docs; make clean)
78 (cd docs; docker run --rm -v $(PWD):/project --workdir=/project/docs sphinx-doc-build-rc make clean)
79
79
80
80
81 .PHONY: docs-cleanup
81 .PHONY: docs-cleanup
82 ## Cleanup docs
82 ## Cleanup docs
83 docs-cleanup:
83 docs-cleanup:
84 (cd docs; make cleanup)
84 (cd docs; docker run --rm -v $(PWD):/project --workdir=/project/docs sphinx-doc-build-rc make cleanup)
85
85
86
86
87 .PHONY: web-build
87 .PHONY: web-build
Show file before | Show file after | Hide comments
@@ -1,9 +1,6 b''
1 # generating packages
1 ## BUILD
2 nix-shell pkgs/shell-generate.nix
2 # cd docs
3 cd docs
3 # docker build --tag sphinx-doc-build-rc .
4 pip2nix generate
5
4
6 # building the docs
5 # Build Docs
7 cd docs
6 # docker run --rm -v $(PWD):/project --workdir=/project/docs sphinx-doc-build-rc make clean html No newline at end of file
8 nix-build default.nix -o result
9 make clean html
Show file before | Show file after | Hide comments
@@ -2,9 +2,9 b''
2 #
2 #
3
3
4 # You can set these variables from the command line.
4 # You can set these variables from the command line.
5 SPHINXOPTS =
5 SPHINXOPTS ?=
6 SPHINXBUILD = ./result/bin/sphinx-build
6 SPHINXBUILD ?= sphinx-build
7 PAPER =
7 SOURCEDIR = source
8 BUILDDIR = _build
8 BUILDDIR = _build
9
9
10 # User-friendly check for sphinx-build
10 # User-friendly check for sphinx-build
Show file before | Show file after | Hide comments
@@ -25,7 +25,7 b' account permissions.'
25 # Open iShell from the terminal
25 # Open iShell from the terminal
26 $ rccontrol ishell enterprise-1
26 $ rccontrol ishell enterprise-1
27
27
28 .. code-block:: mysql
28 .. code-block:: python
29
29
30 # Use this example to change user permissions
30 # Use this example to change user permissions
31 In [1]: adminuser = User.get_by_username('username')
31 In [1]: adminuser = User.get_by_username('username')
@@ -49,7 +49,7 b' following example to make changes to thi'
49 # Open iShell from the terminal
49 # Open iShell from the terminal
50 $ rccontrol ishell enterprise-1
50 $ rccontrol ishell enterprise-1
51
51
52 .. code-block:: mysql
52 .. code-block:: python
53
53
54 # Use this example to enable global .hgrc access
54 # Use this example to enable global .hgrc access
55 In [1]: new_option = RhodeCodeUi()
55 In [1]: new_option = RhodeCodeUi()
@@ -76,7 +76,7 b' Use the following code example to carry '
76 # starts the ishell interactive prompt
76 # starts the ishell interactive prompt
77 $ rccontrol ishell enterprise-1
77 $ rccontrol ishell enterprise-1
78
78
79 .. code-block:: mysql
79 .. code-block:: python
80
80
81 In [1]: from rhodecode.lib.auth import generate_auth_token
81 In [1]: from rhodecode.lib.auth import generate_auth_token
82 In [2]: from rhodecode.lib.auth import get_crypt_password
82 In [2]: from rhodecode.lib.auth import get_crypt_password
@@ -107,7 +107,7 b' Use the following code example to carry '
107 # starts the ishell interactive prompt
107 # starts the ishell interactive prompt
108 $ rccontrol ishell enterprise-1
108 $ rccontrol ishell enterprise-1
109
109
110 .. code-block:: mysql
110 .. code-block:: python
111
111
112 # Use this example to change email and username of LDAP user
112 # Use this example to change email and username of LDAP user
113 In [1]: my_user = User.get_by_username('some_username')
113 In [1]: my_user = User.get_by_username('some_username')
@@ -139,7 +139,7 b" Use the text which is shown after '#' si"
139 # starts the ishell interactive prompt
139 # starts the ishell interactive prompt
140 $ rccontrol ishell enterprise-1
140 $ rccontrol ishell enterprise-1
141
141
142 .. code-block:: mysql
142 .. code-block:: python
143
143
144 # Use this example to change users from authentication
144 # Use this example to change users from authentication
145 # using rhodecode internal to ldap
145 # using rhodecode internal to ldap
Show file before | Show file after | Hide comments
@@ -202,7 +202,6 b' are not required in args.'
202 methods/deprecated-methods
202 methods/deprecated-methods
203 methods/gist-methods
203 methods/gist-methods
204 methods/pull-request-methods
204 methods/pull-request-methods
205 methods/repo-methods
206 methods/repo-group-methods
205 methods/repo-group-methods
207 methods/search-methods
206 methods/search-methods
208 methods/server-methods
207 methods/server-methods
Show file before | Show file after | Hide comments
@@ -1,132 +1,160 b''
1
1 # Configuration file for the Sphinx documentation builder.
2 #
3 # RhodeCode Enterprise documentation build configuration file, created by
4 # sphinx-quickstart on Tue Nov 4 11:48:37 2014.
5 #
6 # This file is execfile()d with the current directory set to its
7 # containing dir.
8 #
2 #
9 # Note that not all possible configuration values are present in this
3 # For the full list of built-in configuration values, see the documentation:
10 # autogenerated file.
4 # https://www.sphinx-doc.org/en/master/usage/configuration.html
11 #
5
12 # All configuration values have a default; values that are commented out
6 # -- Project information -----------------------------------------------------
13 # serve to show the default.
7 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
14
8
9 import os
15 import sys
10 import sys
16 import os
17 import datetime
11 import datetime
18 import sphinx_rtd_theme
12
13 # sphinx injects tags magically during build, we re-define it here to make linters happy
14 tags = tags # noqa
19
15
20 # If extensions (or modules to document with autodoc) are in another directory,
16 # If extensions (or modules to document with autodoc) are in another directory,
21 # add these directories to sys.path here. If the directory is relative to the
17 # add these directories to sys.path here. If the directory is relative to the
22 # documentation root, use os.path.abspath to make it absolute, like shown here.
18 # documentation root, use os.path.abspath to make it absolute, like shown here.
23 sys.path.insert(0, os.path.abspath('.'))
19 sys.path.insert(0, os.path.abspath("."))
24 import common
20
21
22 def _get_version():
23 with open("../rhodecode/VERSION") as f:
24 return f.read().strip()
25
26
27 now = datetime.datetime.today()
28
29 # The full project version, used as the replacement for |release| and e.g. in the HTML templates.
30 # For example, for the Python documentation, this may be something like 2.6.0rc1.
31 # If you don’t need the separation provided between version and release, just set them both to the same value.
32 release = _get_version()
33
34 # The major project version, used as the replacement for |version|.
35 # For example, for the Python documentation, this may be something like 2.6.
36 version = ".".join(release.split(".", 2)[:2]) # First two parts of release
37
38
39 # General information about the project.
40 project = "RhodeCode Enterprise"
41 copyright = f"2010-{now.year}, RhodeCode GmbH"
42 author = "RhodeCode GmbH"
25
43
26 # -- General configuration ------------------------------------------------
44 # -- General configuration ------------------------------------------------
27
45
28 # If your documentation needs a minimal Sphinx version, state it here.
46 # If your documentation needs a minimal Sphinx version, state it here.
29 #needs_sphinx = '1.0'
47 # needs_sphinx = '1.0'
30
48
31 # Add any Sphinx extension module names here, as strings. They can be
49 # Add any Sphinx extension module names here, as strings. They can be
32 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
50 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
33 # ones.
51 # ones.
34 extensions = [
52 extensions = [
35 'sphinx.ext.autodoc',
53 "sphinx.ext.autodoc",
36 'sphinx.ext.intersphinx',
54 "sphinx.ext.intersphinx",
37 'sphinx.ext.todo',
55 "sphinx.ext.todo",
38 'sphinx.ext.imgmath'
56 "sphinx.ext.imgmath",
39 ]
57 ]
40
58
41 intersphinx_mapping = {
59 intersphinx_mapping = {
42 'enterprise': ('https://docs.rhodecode.com/RhodeCode-Enterprise/', None),
60 "enterprise": ("https://docs.rhodecode.com/RhodeCode-Enterprise/", None),
43 'control': ('https://docs.rhodecode.com/RhodeCode-Control/', None),
61 "rcstack": ("https://docs.rhodecode.com/rcstack/", None),
62 "control": ("https://docs.rhodecode.com/RhodeCode-Control/", None),
44 }
63 }
45
64
46 # Add any paths that contain templates here, relative to this directory.
65 # Add any paths that contain templates here, relative to this directory.
47 templates_path = ['_templates']
66 templates_path = ["_templates"]
48
67
49 # The suffix of source filenames.
68 # The suffix of source filenames.
50 source_suffix = '.rst'
69 source_suffix = ".rst"
51
70
52 # The encoding of source files.
71 # The encoding of source files.
53 #source_encoding = 'utf-8-sig'
72 # source_encoding = 'utf-8-sig'
54
73
55 # The master toctree document.
74 # The master toctree document.
56 master_doc = 'index'
75 master_doc = "index"
57
76
58 # The version info for the project you're documenting, acts as replacement for
77 # The version info for the project you're documenting, acts as replacement for
59 # |version| and |release|, also used in various other places throughout the
78 # |version| and |release|, also used in various other places throughout the
60 # built documents.
79 # built documents.
61
80
62
81
63 def _get_version():
64 with open('../rhodecode/VERSION') as f:
65 return f.read().strip()
66
67
68 # The full version, including alpha/beta/rc tags.
69 release = _get_version()
70 # The short X.Y version.
71 version = '.'.join(release.split('.', 2)[:2]) # First two parts of release
72
73 # General information about the project.
74 project = u'RhodeCode Enterprise %s ' % _get_version()
75 copyright = u'2010-{now.year}, RhodeCode GmbH'.format(
76 now=datetime.datetime.today())
77
78
79 # The language for content autogenerated by Sphinx. Refer to documentation
82 # The language for content autogenerated by Sphinx. Refer to documentation
80 # for a list of supported languages.
83 # for a list of supported languages.
81 #language = None
84 # language = None
82
85
83 rst_epilog = common.rst_epilog + """
86 rst_epilog = """
84 .. |async| replace:: asynchronous
87 .. |async| replace:: asynchronous
88 .. |AE| replace:: Appenlight
89 .. |authtoken| replace:: Authentication Token
90 .. |authtokens| replace:: **Auth Tokens**
91 .. |RCCEshort| replace:: Community
92 .. |RCEEshort| replace:: Enterprise
93 .. |git| replace:: Git
94 .. |hg| replace:: Mercurial
95 .. |svn| replace:: Subversion
96 .. |LDAP| replace:: LDAP / Active Directory
97 .. |os| replace:: operating system
98 .. |OS| replace:: Operating System
99 .. |PY| replace:: Python
100 .. |pr| replace:: pull request
101 .. |prs| replace:: pull requests
102 .. |psf| replace:: Python Software Foundation
103 .. |repo| replace:: repository
104 .. |repos| replace:: repositories
105 .. |RCC| replace:: RhodeCode Control
106 .. |RCE| replace:: RhodeCode Enterprise
107 .. |RCCE| replace:: RhodeCode Community
108 .. |RCEE| replace:: RhodeCode Enterprise
109 .. |RCX| replace:: RhodeCode Extensions
110 .. |RCT| replace:: RhodeCode Tools
111 .. |RCEBOLD| replace:: **RhodeCode Enterprise**
112 .. |RCEITALICS| replace:: `RhodeCode Enterprise`
113 .. |RNS| replace:: Release Notes
85 """
114 """
86
115
87 # There are two options for replacing |today|: either, you set today to some
116 # There are two options for replacing |today|: either, you set today to some
88 # non-false value, then it is used:
117 # non-false value, then it is used:
89 #today = ''
118 # today = ''
90 # Else, today_fmt is used as the format for a strftime call.
119 # Else, today_fmt is used as the format for a strftime call.
91 #today_fmt = '%B %d, %Y'
120 # today_fmt = '%B %d, %Y'
92
121
93 # List of patterns, relative to source directory, that match files and
122 # List of patterns, relative to source directory, that match files and
94 # directories to ignore when looking for source files.
123 # directories to ignore when looking for source files.
95 exclude_patterns = [
124 exclude_patterns = [
96 # Special directories
125 # Special directories
97 '_build',
126 "_build",
98 'result',
127 "result",
99
100 # Other RST files
128 # Other RST files
101 'admin/rhodecode-backup.rst',
129 "admin/rhodecode-backup.rst",
102 'issue-trackers/redmine.rst',
130 "issue-trackers/redmine.rst",
103 'known-issues/error-msg-guide.rst',
131 "known-issues/error-msg-guide.rst",
104 'tutorials/docs-build.rst',
132 "tutorials/docs-build.rst",
105 'integrations/example-ext.py',
133 "integrations/example-ext.py",
106 'collaboration/supported-workflows.rst',
134 "collaboration/supported-workflows.rst",
107 ]
135 ]
108
136
109
137
110 # The reST default role (used for this markup: `text`) to use for all
138 # The reST default role (used for this markup: `text`) to use for all
111 # documents.
139 # documents.
112 #default_role = None
140 # default_role = None
113
141
114 # If true, '()' will be appended to :func: etc. cross-reference text.
142 # If true, '()' will be appended to :func: etc. cross-reference text.
115 #add_function_parentheses = True
143 # add_function_parentheses = True
116
144
117 # If true, the current module name will be prepended to all description
145 # If true, the current module name will be prepended to all description
118 # unit titles (such as .. function::).
146 # unit titles (such as .. function::).
119 #add_module_names = True
147 # add_module_names = True
120
148
121 # If true, sectionauthor and moduleauthor directives will be shown in the
149 # If true, sectionauthor and moduleauthor directives will be shown in the
122 # output. They are ignored by default.
150 # output. They are ignored by default.
123 #show_authors = False
151 # show_authors = False
124
152
125 # The name of the Pygments (syntax highlighting) style to use.
153 # The name of the Pygments (syntax highlighting) style to use.
126 pygments_style = 'sphinx'
154 pygments_style = "sphinx"
127
155
128 # A list of ignored prefixes for module index sorting.
156 # A list of ignored prefixes for module index sorting.
129 #modindex_common_prefix = []
157 # modindex_common_prefix = []
130
158
131 # If true, keep warnings as "system message" paragraphs in the built documents.
159 # If true, keep warnings as "system message" paragraphs in the built documents.
132 keep_warnings = tags.has("dev")
160 keep_warnings = tags.has("dev")
@@ -136,135 +164,138 b' keep_warnings = tags.has("dev")'
136
164
137 # The theme to use for HTML and HTML Help pages. See the documentation for
165 # The theme to use for HTML and HTML Help pages. See the documentation for
138 # a list of builtin themes.
166 # a list of builtin themes.
139 #html_theme = 'rctheme'
167 html_theme = "furo"
140 html_theme = 'sphinx_rtd_theme'
141
168
142 # Theme options are theme-specific and customize the look and feel of a theme
169 # Theme options are theme-specific and customize the look and feel of a theme
143 # further. For a list of options available for each theme, see the
170 # further. For a list of options available for each theme, see the
144 # documentation.
171 # documentation.
145 #html_theme_options = {}
172 # html_theme_options = {}
146 html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
173
147
174
148 # Add any paths that contain custom themes here, relative to this directory.
175 # Add any paths that contain custom themes here, relative to this directory.
149 #html_theme_path = []
176 # html_theme_path = []
150
177
151 # The name for this set of Sphinx documents. If None, it defaults to
178 # The name for this set of Sphinx documents. If None, it defaults to
152 # "<project> v<release> documentation".
179 # "<project> v<release> documentation".
153 #html_title = None
180 # html_title = None
154
181
155 # A shorter title for the navigation bar. Default is the same as html_title.
182 # A shorter title for the navigation bar. Default is the same as html_title.
156 #html_short_title = None
183 # html_short_title = None
157
184
158 # The name of an image file (relative to this directory) to place at the top
185 # The name of an image file (relative to this directory) to place at the top
159 # of the sidebar.
186 # of the sidebar.
160 #html_logo = None
187 # html_logo = None
161 html_sidebars = {
188
162 '**': ['globaltoc.html'],
189
163 }
190 #html_sidebars = {
191 # "**": ["globaltoc.html"],
192 #}
164
193
165 # The name of an image file (within the static path) to use as favicon of the
194 # The name of an image file (within the static path) to use as favicon of the
166 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
195 # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
167 # pixels large.
196 # pixels large.
168 html_favicon = 'images/favicon.ico'
197 html_favicon = "images/favicon.ico"
169
198
170 # Add any paths that contain custom static files (such as style sheets) here,
199 # Add any paths that contain custom static files (such as style sheets) here,
171 # relative to this directory. They are copied after the builtin static files,
200 # relative to this directory. They are copied after the builtin static files,
172 # so a file named "default.css" will overwrite the builtin "default.css".
201 # so a file named "default.css" will overwrite the builtin "default.css".
173 html_static_path = ['static/css/add.css']
202 html_static_path = ["static/css/add.css"]
174
203
175 # Add any extra paths that contain custom files (such as robots.txt or
204 # Add any extra paths that contain custom files (such as robots.txt or
176 # .htaccess) here, relative to this directory. These files are copied
205 # .htaccess) here, relative to this directory. These files are copied
177 # directly to the root of the documentation.
206 # directly to the root of the documentation.
178 #html_extra_path = []
207 # html_extra_path = []
179
208
180 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
209 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
181 # using the given strftime format.
210 # using the given strftime format.
182 #html_last_updated_fmt = '%b %d, %Y'
211 html_last_updated_fmt = " %H:%m %b %d, %Y"
183
212
184 # If true, SmartyPants will be used to convert quotes and dashes to
213 # If true, SmartyPants will be used to convert quotes and dashes to
185 # typographically correct entities.
214 # typographically correct entities.
186 #html_use_smartypants = True
215 # html_use_smartypants = True
187
216
188 # Custom sidebar templates, maps document names to template names.
217 # Custom sidebar templates, maps document names to template names.
189 #html_sidebars = {}
218 # html_sidebars = {}
190
219
191 # Additional templates that should be rendered to pages, maps page names to
220 # Additional templates that should be rendered to pages, maps page names to
192 # template names.
221 # template names.
193 #html_additional_pages = {}
222 # html_additional_pages = {}
194
223
195 # If false, no module index is generated.
224 # If false, no module index is generated.
196 #html_domain_indices = True
225 # html_domain_indices = True
197
226
198 # If false, no index is generated.
227 # If false, no index is generated.
199 #html_use_index = True
228 # html_use_index = True
200
229
201 # If true, the index is split into individual pages for each letter.
230 # If true, the index is split into individual pages for each letter.
202 #html_split_index = False
231 # html_split_index = False
203
232
204 # If true, links to the reST sources are added to the pages.
233 # If true, links to the reST sources are added to the pages.
205 #html_show_sourcelink = True
234 # html_show_sourcelink = True
206
235
207 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
236 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
208 #html_show_sphinx = True
237 html_show_sphinx = False
209
238
210 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
239 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
211 #html_show_copyright = True
240 # html_show_copyright = True
212
241
213 # If true, an OpenSearch description file will be output, and all pages will
242 # If true, an OpenSearch description file will be output, and all pages will
214 # contain a <link> tag referring to it. The value of this option must be the
243 # contain a <link> tag referring to it. The value of this option must be the
215 # base URL from which the finished HTML is served.
244 # base URL from which the finished HTML is served.
216 #html_use_opensearch = ''
245 # html_use_opensearch = ''
217
246
218 # This is the file name suffix for HTML files (e.g. ".xhtml").
247 # This is the file name suffix for HTML files (e.g. ".xhtml").
219 #html_file_suffix = None
248 # html_file_suffix = None
220
249
221 # Output file base name for HTML help builder.
250 # Output file base name for HTML help builder.
222 htmlhelp_basename = 'rhodecode-enterprise'
251 htmlhelp_basename = "rhodecode-enterprise"
223
252
224
253
225 # -- Options for LaTeX output ---------------------------------------------
254 # -- Options for LaTeX output ---------------------------------------------
226
255
227 latex_elements = {
256 latex_elements = {
228 'classoptions': ',oneside',
257 "classoptions": ",oneside",
229 'babel': '\\usepackage[english]{babel}',
258 "babel": "\\usepackage[english]{babel}",
230
259 # The paper size ('letterpaper' or 'a4paper').
231 # The paper size ('letterpaper' or 'a4paper').
260 #'papersize': 'letterpaper',
232 #'papersize': 'letterpaper',
261 # The font size ('10pt', '11pt' or '12pt').
233
262 #'pointsize': '10pt',
234 # The font size ('10pt', '11pt' or '12pt').
263 # Additional stuff for the LaTeX preamble.
235 #'pointsize': '10pt',
264 #'preamble': '',
236
237 # Additional stuff for the LaTeX preamble.
238 #'preamble': '',
239 }
265 }
240
266
241 # Grouping the document tree into LaTeX files. List of tuples
267 # Grouping the document tree into LaTeX files. List of tuples
242 # (source start file, target name, title,
268 # (source start file, target name, title,
243 # author, documentclass [howto, manual, or own class]).
269 # author, documentclass [howto, manual, or own class]).
244 latex_documents = [
270 latex_documents = [
245 ('index', 'RhodeCodeEnterprise.tex', u'RhodeCode Enterprise',
271 (
246 u'RhodeCode GmbH', 'manual'),
272 "index",
273 "RhodeCodeEnterprise.tex",
274 "RhodeCode Enterprise",
275 "RhodeCode GmbH",
276 "manual",
277 ),
247 ]
278 ]
248
279
249 # The name of an image file (relative to this directory) to place at the top of
280 # The name of an image file (relative to this directory) to place at the top of
250 # the title page.
281 # the title page.
251 #latex_logo = None
282 # latex_logo = None
252
283
253 # For "manual" documents, if this is true, then toplevel headings are parts,
284 # For "manual" documents, if this is true, then toplevel headings are parts,
254 # not chapters.
285 # not chapters.
255 #latex_use_parts = False
286 # latex_use_parts = False
256
287
257 # If true, show page references after internal links.
288 # If true, show page references after internal links.
258 latex_show_pagerefs = True
289 latex_show_pagerefs = True
259
290
260 # If true, show URL addresses after external links.
291 # If true, show URL addresses after external links.
261 latex_show_urls = 'footnote'
292 latex_show_urls = "footnote"
262
293
263 # Documents to append as an appendix to all manuals.
294 # Documents to append as an appendix to all manuals.
264 #latex_appendices = []
295 # latex_appendices = []
265
296
266 # If false, no module index is generated.
297 # If false, no module index is generated.
267 #latex_domain_indices = True
298 # latex_domain_indices = True
268
299
269 # Mode for literal blocks wider than the frame. Can be
300 # Mode for literal blocks wider than the frame. Can be
270 # overflow, shrink or truncate
301 # overflow, shrink or truncate
@@ -276,12 +307,11 b' pdf_fit_mode = "truncate"'
276 # One entry per manual page. List of tuples
307 # One entry per manual page. List of tuples
277 # (source start file, name, description, authors, manual section).
308 # (source start file, name, description, authors, manual section).
278 man_pages = [
309 man_pages = [
279 ('index', 'rhodecodeenterprise', u'RhodeCode Enterprise',
310 ("index", "rhodecodeenterprise", "RhodeCode Enterprise", ["RhodeCode GmbH"], 1)
280 [u'RhodeCode GmbH'], 1)
281 ]
311 ]
282
312
283 # If true, show URL addresses after external links.
313 # If true, show URL addresses after external links.
284 #man_show_urls = False
314 # man_show_urls = False
285
315
286
316
287 # -- Options for Texinfo output -------------------------------------------
317 # -- Options for Texinfo output -------------------------------------------
@@ -290,22 +320,28 b' man_pages = ['
290 # (source start file, target name, title, author,
320 # (source start file, target name, title, author,
291 # dir menu entry, description, category)
321 # dir menu entry, description, category)
292 texinfo_documents = [
322 texinfo_documents = [
293 ('index', 'RhodeCodeEnterprise', u'RhodeCode Enterprise',
323 (
294 u'RhodeCode Docs Team', 'RhodeCodeEnterprise', 'RhodeCode Docs Project',
324 "index",
295 'Miscellaneous'),
325 "RhodeCodeEnterprise",
326 "RhodeCode Enterprise",
327 "RhodeCode Docs Team",
328 "RhodeCodeEnterprise",
329 "RhodeCode Docs Project",
330 "Miscellaneous",
331 ),
296 ]
332 ]
297
333
298 # Documents to append as an appendix to all manuals.
334 # Documents to append as an appendix to all manuals.
299 #texinfo_appendices = []
335 # texinfo_appendices = []
300
336
301 # If false, no module index is generated.
337 # If false, no module index is generated.
302 #texinfo_domain_indices = True
338 # texinfo_domain_indices = True
303
339
304 # How to display URL addresses: 'footnote', 'no', or 'inline'.
340 # How to display URL addresses: 'footnote', 'no', or 'inline'.
305 #texinfo_show_urls = 'footnote'
341 # texinfo_show_urls = 'footnote'
306
342
307 # If true, do not generate a @detailmenu in the "Top" node's menu.
343 # If true, do not generate a @detailmenu in the "Top" node's menu.
308 #texinfo_no_detailmenu = False
344 # texinfo_no_detailmenu = False
309
345
310 # We want to see todo notes in case of a pre-release build of the documentation
346 # We want to see todo notes in case of a pre-release build of the documentation
311 todo_include_todos = tags.has("dev")
347 todo_include_todos = tags.has("dev")
Show file before | Show file after | Hide comments
@@ -1,7 +1,11 b''
1 sphinx==1.8.2
1 sphinx==7.2.6
2 six==1.11.0
2
3 sphinx_rtd_theme==0.4.1
3 furo==2023.9.10
4 docutils==0.16.0
4 sphinx-press-theme==0.8.0
5 pygments==2.3.0
5 sphinx-rtd-theme==1.3.0
6 markupsafe==1.0.0
6
7 jinja2==2.9.6
7 pygments==2.16.1
8
9 docutils<0.19
10 markupsafe==2.1.3
11 jinja2==3.1.2
Show file before | Show file after | Hide comments
1 NO CONTENT: file was removed
NO CONTENT: file was removed
Show file before | Show file after | Hide comments
1 NO CONTENT: file was removed
NO CONTENT: file was removed
Show file before | Show file after | Hide comments
1 NO CONTENT: file was removed
NO CONTENT: file was removed
Show file before | Show file after | Hide comments
1 NO CONTENT: file was removed
NO CONTENT: file was removed
Show file before | Show file after | Hide comments
1 NO CONTENT: file was removed
NO CONTENT: file was removed
Show file before | Show file after | Hide comments
1 NO CONTENT: file was removed
NO CONTENT: file was removed
General Comments 0
You need to be logged in to leave comments. Login now