##// END OF EJS Templates
rhodecode-enterprise-ce
RSS
docs(5.x): added new tempalte and bootstrapped 5.X docs
super-admin -
r5343:dad82407 stable
parent child Browse files
Show More
Show file before | Show file after | Hide comments
1 NO CONTENT: new file 100644
Show file before | Show file after | Hide comments
@@ -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 Enterprise {{ release }} docs
31 </span>
32 {%- endif %}
33 {% endblock brand_content %}
34 </a> No newline at end of file
Show file before | Show file after | Hide comments
@@ -0,0 +1,45 b''
1 |RCE| 5.0.0 |RNS|
2 -----------------
3
4 Release Date
5 ^^^^^^^^^^^^
6
7 - TBA
8
9
10 New Features
11 ^^^^^^^^^^^^
12
13 - Full support of Python3 and Python3.11
14
15
16 General
17 ^^^^^^^
18
19 - Upgraded all dependency libraries to their latest available versions
20
21
22 Security
23 ^^^^^^^^
24
25
26
27 Performance
28 ^^^^^^^^^^^
29
30
31
32 Fixes
33 ^^^^^
34
35
36
37 Upgrade notes
38 ^^^^^^^^^^^^^
39
40 - RhodeCode 5.0.0 is a mayor upgrade that support latest Python versions 3.11,
41 and also comes with lots of internal changes and performance improvements.
42 - RhodeCode 5.0.0 is only supported via our new docker rcstack installer or helm/k8s stack
43 - Please see migration guide :ref:`rcstack:migration-to-rcstack`
44 - RhodeCode 5.0.0 also requires a new license for EE instances, please reach out to us via support@rhodecode.com to
45 convert your license key.
Show file before | Show file after | Hide comments
@@ -4,11 +4,20 b' WORKDIR /project'
4 4
5 5 RUN apt-get update \
6 6 && apt-get install --no-install-recommends --yes \
7 curl \
8 zip \
9 graphviz \
10 imagemagick \
11 make \
7 curl \
8 zip \
9 graphviz \
10 dvipng \
11 imagemagick \
12 make \
13 latexmk \
14 texlive-latex-recommended \
15 texlive-latex-extra \
16 texlive-xetex \
17 fonts-freefont-otf \
18 texlive-fonts-recommended \
19 texlive-lang-greek \
20 tex-gyre \
12 21 && apt-get autoremove \
13 22 && apt-get clean \
14 23 && rm -rf /var/lib/apt/lists/*
Show file before | Show file after | Hide comments
@@ -1,183 +1,20 b''
1 # Makefile for Sphinx documentation
1 # Minimal makefile for Sphinx documentation
2 2 #
3 3
4 # You can set these variables from the command line.
4 # You can set these variables from the command line, and also
5 # from the environment for the first two.
5 6 SPHINXOPTS ?=
6 7 SPHINXBUILD ?= sphinx-build
7 SOURCEDIR = source
8 SOURCEDIR = .
8 9 BUILDDIR = _build
9 10
10 # User-friendly check for sphinx-build
11 ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
12 $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
13 endif
14
15 # Internal variables.
16 PAPEROPT_a4 = -D latex_paper_size=a4
17 PAPEROPT_letter = -D latex_paper_size=letter
18 ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
19 # the i18n builder cannot share the environment and doctrees with the others
20 I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
21
22 .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
23
11 # Put it first so that "make" without argument is like "make help".
24 12 help:
25 @echo "Please use \`make <target>' where <target> is one of"
26 @echo " html to make standalone HTML files"
27 @echo " dirhtml to make HTML files named index.html in directories"
28 @echo " singlehtml to make a single large HTML file"
29 @echo " pickle to make pickle files"
30 @echo " json to make JSON files"
31 @echo " htmlhelp to make HTML files and a HTML help project"
32 @echo " qthelp to make HTML files and a qthelp project"
33 @echo " devhelp to make HTML files and a Devhelp project"
34 @echo " epub to make an epub"
35 @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
36 @echo " latexpdf to make LaTeX files and run them through pdflatex"
37 @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
38 @echo " text to make text files"
39 @echo " man to make manual pages"
40 @echo " texinfo to make Texinfo files"
41 @echo " info to make Texinfo files and run them through makeinfo"
42 @echo " gettext to make PO message catalogs"
43 @echo " changes to make an overview of all changed/added/deprecated items"
44 @echo " xml to make Docutils-native XML files"
45 @echo " pseudoxml to make pseudoxml-XML files for display purposes"
46 @echo " linkcheck to check all external links for integrity"
47 @echo " doctest to run all doctests embedded in the documentation (if enabled)"
48
49 clean:
50 rm -rf $(BUILDDIR)/*
51
52 cleanup:
53 @echo "cleaning build dir"
54 rm -rf $(BUILDDIR)/*
55 @echo "cleaning result symlink"
56 rm -v result
57
58 html:
59 $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
60 @echo
61 @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
62
63 dirhtml:
64 $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
65 @echo
66 @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
67
68 singlehtml:
69 $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
70 @echo
71 @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
72
73 pickle:
74 $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
75 @echo
76 @echo "Build finished; now you can process the pickle files."
77
78 json:
79 $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
80 @echo
81 @echo "Build finished; now you can process the JSON files."
82
83 htmlhelp:
84 $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
85 @echo
86 @echo "Build finished; now you can run HTML Help Workshop with the" \
87 ".hhp project file in $(BUILDDIR)/htmlhelp."
13 @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
88 14
89 qthelp:
90 $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
91 @echo
92 @echo "Build finished; now you can run "qcollectiongenerator" with the" \
93 ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
94 @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/RhodeCodeInstaller.qhcp"
95 @echo "To view the help file:"
96 @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/RhodeCodeInstaller.qhc"
97
98 devhelp:
99 $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
100 @echo
101 @echo "Build finished."
102 @echo "To view the help file:"
103 @echo "# mkdir -p $$HOME/.local/share/devhelp/RhodeCodeInstaller"
104 @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/RhodeCodeInstaller"
105 @echo "# devhelp"
106
107 epub:
108 $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
109 @echo
110 @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
111
112 latex:
113 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
114 @echo
115 @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
116 @echo "Run \`make' in that directory to run these through (pdf)latex" \
117 "(use \`make latexpdf' here to do that automatically)."
118
119 latexpdf:
120 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
121 @echo "Running LaTeX files through pdflatex..."
122 $(MAKE) -C $(BUILDDIR)/latex all-pdf
123 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
124
125 latexpdfja:
126 $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
127 @echo "Running LaTeX files through platex and dvipdfmx..."
128 $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
129 @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
130
131 text:
132 $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
133 @echo
134 @echo "Build finished. The text files are in $(BUILDDIR)/text."
15 .PHONY: help Makefile
135 16
136 man:
137 $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
138 @echo
139 @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
140
141 texinfo:
142 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
143 @echo
144 @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
145 @echo "Run \`make' in that directory to run these through makeinfo" \
146 "(use \`make info' here to do that automatically)."
147
148 info:
149 $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
150 @echo "Running Texinfo files through makeinfo..."
151 make -C $(BUILDDIR)/texinfo info
152 @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
153
154 gettext:
155 $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
156 @echo
157 @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
158
159 changes:
160 $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
161 @echo
162 @echo "The overview file is in $(BUILDDIR)/changes."
163
164 linkcheck:
165 $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
166 @echo
167 @echo "Link check complete; look for any errors in the above output " \
168 "or in $(BUILDDIR)/linkcheck/output.txt."
169
170 doctest:
171 $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
172 @echo "Testing of doctests in the sources finished, look at the " \
173 "results in $(BUILDDIR)/doctest/output.txt."
174
175 xml:
176 $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
177 @echo
178 @echo "Build finished. The XML files are in $(BUILDDIR)/xml."
179
180 pseudoxml:
181 $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
182 @echo
183 @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
17 # Catch-all target: route all unknown targets to Sphinx using the new
18 # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19 %: Makefile
20 @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
Show file before | Show file after | Hide comments
@@ -87,7 +87,7 b''
87 87 <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
88 88 </label>
89 89 </div>
90 <article role="main">
90 <article role="main" id="furo-main-content">
91 91 {% block content %}{{ body }}{% endblock %}
92 92 </article>
93 93 </div>
@@ -141,6 +141,9 b''
141 141 {% trans %}<a href="https://www.sphinx-doc.org/">Sphinx</a> and {% endtrans -%}
142 142 <a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
143 143 {% endif -%}
144
145
146
144 147 {%- if last_updated -%}
145 148 <div class="last-updated">
146 149 {% trans last_updated=last_updated|e -%}
@@ -149,7 +152,7 b''
149 152 </div>
150 153
151 154 <div style="border-top: 0">
152 Got documentation defects and suggestions? <a href="https://community.rhodecode.com">Submit docs issues</a>
155 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 156 </div>
154 157
155 158 {%- endif %}
@@ -172,6 +175,9 b''
172 175 </svg>
173 176 </a>
174 177 {%- endif -%}
178 {#- Show GitHub repository home -#}
179 {%- if READTHEDOCS and display_github and github_user != "None" and github_repo != "None" -%}
180 {%- endif -%}
175 181 {%- endif %}
176 182 </div>
177 183 {%- endif %}
@@ -200,5 +206,4 b''
200 206 </aside>
201 207 </div>
202 208 </div>
203
204 209 {%- endblock %}
Show file before | Show file after | Hide comments
@@ -3,6 +3,15 b''
3 3 Release Notes
4 4 =============
5 5
6 |RCE| 5.x Versions
7 ------------------
8
9 .. toctree::
10 :maxdepth: 1
11
12 release-notes-5.0.0.rst
13
14
6 15 |RCE| 4.x Versions
7 16 ------------------
8 17
General Comments 0
You need to be logged in to leave comments. Login now