Skip to content

Commit e5c02d0

Browse files
JakeWhartonJakeWharton
authored
Commit 2.x docs (#4378)
Current version is 3.x
1 parent 5bc3f18 commit e5c02d0

File tree

399 files changed

+59153
-11
lines changed

Some content is hidden

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

399 files changed

+59153
-11
lines changed

‎build.gradle‎

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -103,17 +103,18 @@ tasks.register('copyWebsiteDocs', Copy) {
103103
description = 'Copies generated documentation to the website'
104104
group = JavaBasePlugin.DOCUMENTATION_GROUP
105105

106-
into layout.projectDirectory.dir('website/public/2.x')
107-
subprojects { subproject ->
108-
if (subproject.name == 'retrofit-bom') return
109-
if (!subproject.plugins.hasPlugin('com.vanniktech.maven.publish')) return
106+
into layout.projectDirectory.dir('website/public/3.x')
110107

111-
into(subproject.POM_ARTIFACT_ID) {
112-
if (subproject.plugins.hasPlugin('org.jetbrains.dokka')) {
113-
from subproject.tasks.named('dokkaHtml').flatMap { it.outputDirectory }
114-
} else {
115-
from subproject.tasks.named('javadoc').map { it.destinationDir }
116-
}
108+
subprojects { subproject ->
109+
if (subproject.name == 'retrofit-bom') return
110+
if (!subproject.plugins.hasPlugin('com.vanniktech.maven.publish')) return
111+
112+
into(subproject.POM_ARTIFACT_ID) {
113+
if (subproject.plugins.hasPlugin('org.jetbrains.dokka')) {
114+
from subproject.tasks.named('dokkaHtml').flatMap { it.outputDirectory }
115+
} else {
116+
from subproject.tasks.named('javadoc').map { it.destinationDir }
117117
}
118118
}
119119
}
120+
}

‎website/.gitignore‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,4 @@ dist/
33
node_modules/
44

55
# Populated by ./gradlew copyWebsiteDocs
6-
public/2.x/
6+
public/3.x/

‎website/astro.config.mjs‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,32 @@ export default defineConfig({
4444
{
4545
label: 'Javadoc',
4646
collapsed: true,
47+
items: [
48+
{ label: 'retrofit', link: '/3.x/retrofit/' },
49+
{ label: 'retrofit-mock', link: '/3.x/retrofit-mock/' },
50+
{ label: 'converter-gson', link: '/3.x/converter-gson/' },
51+
{ label: 'converter-guava', link: '/3.x/converter-guava/' },
52+
{ label: 'converter-jackson', link: '/3.x/converter-jackson/' },
53+
{ label: 'converter-java8', link: '/3.x/converter-java8/' },
54+
{ label: 'converter-jaxb', link: '/3.x/converter-jaxb/' },
55+
{ label: 'converter-jaxb3', link: '/3.x/converter-jaxb3/' },
56+
{ label: 'converter-kotlinx-serialization', link: '/3.x/converter-kotlinx-serialization/' },
57+
{ label: 'converter-moshi', link: '/3.x/converter-moshi/' },
58+
{ label: 'converter-protobuf', link: '/3.x/converter-protobuf/' },
59+
{ label: 'converter-scalars', link: '/3.x/converter-scalars/' },
60+
{ label: 'converter-simplexml', link: '/3.x/converter-simplexml/' },
61+
{ label: 'converter-wire', link: '/3.x/converter-wire/' },
62+
{ label: 'adapter-guava', link: '/3.x/adapter-guava/' },
63+
{ label: 'adapter-java8', link: '/3.x/adapter-java8/' },
64+
{ label: 'adapter-rxjava', link: '/3.x/adapter-rxjava/' },
65+
{ label: 'adapter-rxjava2', link: '/3.x/adapter-rxjava2/' },
66+
{ label: 'adapter-rxjava3', link: '/3.x/adapter-rxjava3/' },
67+
{ label: 'adapter-scala', link: '/3.x/adapter-scala/' },
68+
],
69+
},
70+
{
71+
label: 'Javadoc (2.x)',
72+
collapsed: true,
4773
items: [
4874
{ label: 'retrofit', link: '/2.x/retrofit/' },
4975
{ label: 'retrofit-mock', link: '/2.x/retrofit-mock/' },

‎website/public/2.x/adapter-guava/allclasses-frame.html‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2+
<!-- NewPage -->
3+
<html lang="en">
4+
<head>
5+
<!-- Generated by javadoc -->
6+
<title>All Classes (guava API)</title>
7+
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
8+
<script type="text/javascript" src="script.js"></script>
9+
</head>
10+
<body>
11+
<h1 class="bar">All&nbsp;Classes</h1>
12+
<div class="indexContainer">
13+
<ul>
14+
<li><a href="retrofit2/adapter/guava/GuavaCallAdapterFactory.html" title="class in retrofit2.adapter.guava" target="classFrame">GuavaCallAdapterFactory</a></li>
15+
<li><a href="retrofit2/adapter/guava/HttpException.html" title="class in retrofit2.adapter.guava" target="classFrame">HttpException</a></li>
16+
</ul>
17+
</div>
18+
</body>
19+
</html>

‎website/public/2.x/adapter-guava/allclasses-noframe.html‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2+
<!-- NewPage -->
3+
<html lang="en">
4+
<head>
5+
<!-- Generated by javadoc -->
6+
<title>All Classes (guava API)</title>
7+
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
8+
<script type="text/javascript" src="script.js"></script>
9+
</head>
10+
<body>
11+
<h1 class="bar">All&nbsp;Classes</h1>
12+
<div class="indexContainer">
13+
<ul>
14+
<li><a href="retrofit2/adapter/guava/GuavaCallAdapterFactory.html" title="class in retrofit2.adapter.guava">GuavaCallAdapterFactory</a></li>
15+
<li><a href="retrofit2/adapter/guava/HttpException.html" title="class in retrofit2.adapter.guava">HttpException</a></li>
16+
</ul>
17+
</div>
18+
</body>
19+
</html>

‎website/public/2.x/adapter-guava/constant-values.html‎

Lines changed: 119 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,119 @@
1+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2+
<!-- NewPage -->
3+
<html lang="en">
4+
<head>
5+
<!-- Generated by javadoc -->
6+
<title>Constant Field Values (guava API)</title>
7+
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
8+
<script type="text/javascript" src="script.js"></script>
9+
</head>
10+
<body>
11+
<script type="text/javascript"><!--
12+
try {
13+
if (location.href.indexOf('is-external=true') == -1) {
14+
parent.document.title="Constant Field Values (guava API)";
15+
}
16+
}
17+
catch(err) {
18+
}
19+
//-->
20+
</script>
21+
<noscript>
22+
<div>JavaScript is disabled on your browser.</div>
23+
</noscript>
24+
<!-- ========= START OF TOP NAVBAR ======= -->
25+
<div class="topNav"><a name="navbar.top">
26+
<!-- -->
27+
</a>
28+
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
29+
<a name="navbar.top.firstrow">
30+
<!-- -->
31+
</a>
32+
<ul class="navList" title="Navigation">
33+
<li><a href="retrofit2/adapter/guava/package-summary.html">Package</a></li>
34+
<li>Class</li>
35+
<li><a href="overview-tree.html">Tree</a></li>
36+
<li><a href="deprecated-list.html">Deprecated</a></li>
37+
<li><a href="index-all.html">Index</a></li>
38+
<li><a href="help-doc.html">Help</a></li>
39+
</ul>
40+
</div>
41+
<div class="subNav">
42+
<ul class="navList">
43+
<li>Prev</li>
44+
<li>Next</li>
45+
</ul>
46+
<ul class="navList">
47+
<li><a href="index.html?constant-values.html" target="_top">Frames</a></li>
48+
<li><a href="constant-values.html" target="_top">No&nbsp;Frames</a></li>
49+
</ul>
50+
<ul class="navList" id="allclasses_navbar_top">
51+
<li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
52+
</ul>
53+
<div>
54+
<script type="text/javascript"><!--
55+
allClassesLink = document.getElementById("allclasses_navbar_top");
56+
if(window==top) {
57+
allClassesLink.style.display = "block";
58+
}
59+
else {
60+
allClassesLink.style.display = "none";
61+
}
62+
//-->
63+
</script>
64+
</div>
65+
<a name="skip.navbar.top">
66+
<!-- -->
67+
</a></div>
68+
<!-- ========= END OF TOP NAVBAR ========= -->
69+
<div class="header">
70+
<h1 title="Constant Field Values" class="title">Constant Field Values</h1>
71+
<h2 title="Contents">Contents</h2>
72+
</div>
73+
<!-- ======= START OF BOTTOM NAVBAR ====== -->
74+
<div class="bottomNav"><a name="navbar.bottom">
75+
<!-- -->
76+
</a>
77+
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
78+
<a name="navbar.bottom.firstrow">
79+
<!-- -->
80+
</a>
81+
<ul class="navList" title="Navigation">
82+
<li><a href="retrofit2/adapter/guava/package-summary.html">Package</a></li>
83+
<li>Class</li>
84+
<li><a href="overview-tree.html">Tree</a></li>
85+
<li><a href="deprecated-list.html">Deprecated</a></li>
86+
<li><a href="index-all.html">Index</a></li>
87+
<li><a href="help-doc.html">Help</a></li>
88+
</ul>
89+
</div>
90+
<div class="subNav">
91+
<ul class="navList">
92+
<li>Prev</li>
93+
<li>Next</li>
94+
</ul>
95+
<ul class="navList">
96+
<li><a href="index.html?constant-values.html" target="_top">Frames</a></li>
97+
<li><a href="constant-values.html" target="_top">No&nbsp;Frames</a></li>
98+
</ul>
99+
<ul class="navList" id="allclasses_navbar_bottom">
100+
<li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
101+
</ul>
102+
<div>
103+
<script type="text/javascript"><!--
104+
allClassesLink = document.getElementById("allclasses_navbar_bottom");
105+
if(window==top) {
106+
allClassesLink.style.display = "block";
107+
}
108+
else {
109+
allClassesLink.style.display = "none";
110+
}
111+
//-->
112+
</script>
113+
</div>
114+
<a name="skip.navbar.bottom">
115+
<!-- -->
116+
</a></div>
117+
<!-- ======== END OF BOTTOM NAVBAR ======= -->
118+
</body>
119+
</html>

‎website/public/2.x/adapter-guava/deprecated-list.html‎

Lines changed: 143 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,143 @@
1+
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2+
<!-- NewPage -->
3+
<html lang="en">
4+
<head>
5+
<!-- Generated by javadoc -->
6+
<title>Deprecated List (guava API)</title>
7+
<link rel="stylesheet" type="text/css" href="stylesheet.css" title="Style">
8+
<script type="text/javascript" src="script.js"></script>
9+
</head>
10+
<body>
11+
<script type="text/javascript"><!--
12+
try {
13+
if (location.href.indexOf('is-external=true') == -1) {
14+
parent.document.title="Deprecated List (guava API)";
15+
}
16+
}
17+
catch(err) {
18+
}
19+
//-->
20+
</script>
21+
<noscript>
22+
<div>JavaScript is disabled on your browser.</div>
23+
</noscript>
24+
<!-- ========= START OF TOP NAVBAR ======= -->
25+
<div class="topNav"><a name="navbar.top">
26+
<!-- -->
27+
</a>
28+
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
29+
<a name="navbar.top.firstrow">
30+
<!-- -->
31+
</a>
32+
<ul class="navList" title="Navigation">
33+
<li><a href="retrofit2/adapter/guava/package-summary.html">Package</a></li>
34+
<li>Class</li>
35+
<li><a href="overview-tree.html">Tree</a></li>
36+
<li class="navBarCell1Rev">Deprecated</li>
37+
<li><a href="index-all.html">Index</a></li>
38+
<li><a href="help-doc.html">Help</a></li>
39+
</ul>
40+
</div>
41+
<div class="subNav">
42+
<ul class="navList">
43+
<li>Prev</li>
44+
<li>Next</li>
45+
</ul>
46+
<ul class="navList">
47+
<li><a href="index.html?deprecated-list.html" target="_top">Frames</a></li>
48+
<li><a href="deprecated-list.html" target="_top">No&nbsp;Frames</a></li>
49+
</ul>
50+
<ul class="navList" id="allclasses_navbar_top">
51+
<li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
52+
</ul>
53+
<div>
54+
<script type="text/javascript"><!--
55+
allClassesLink = document.getElementById("allclasses_navbar_top");
56+
if(window==top) {
57+
allClassesLink.style.display = "block";
58+
}
59+
else {
60+
allClassesLink.style.display = "none";
61+
}
62+
//-->
63+
</script>
64+
</div>
65+
<a name="skip.navbar.top">
66+
<!-- -->
67+
</a></div>
68+
<!-- ========= END OF TOP NAVBAR ========= -->
69+
<div class="header">
70+
<h1 title="Deprecated API" class="title">Deprecated API</h1>
71+
<h2 title="Contents">Contents</h2>
72+
<ul>
73+
<li><a href="#exception">Deprecated Exceptions</a></li>
74+
</ul>
75+
</div>
76+
<div class="contentContainer"><a name="exception">
77+
<!-- -->
78+
</a>
79+
<ul class="blockList">
80+
<li class="blockList">
81+
<table class="deprecatedSummary" border="0" cellpadding="3" cellspacing="0" summary="Deprecated Exceptions table, listing deprecated exceptions, and an explanation">
82+
<caption><span>Deprecated Exceptions</span><span class="tabEnd">&nbsp;</span></caption>
83+
<tr>
84+
<th class="colOne" scope="col">Exceptions and Description</th>
85+
</tr>
86+
<tbody>
87+
<tr class="altColor">
88+
<td class="colOne"><a href="retrofit2/adapter/guava/HttpException.html" title="class in retrofit2.adapter.guava">retrofit2.adapter.guava.HttpException</a>
89+
<div class="block"><span class="deprecationComment">Use <code>HttpException</code>.</span></div>
90+
</td>
91+
</tr>
92+
</tbody>
93+
</table>
94+
</li>
95+
</ul>
96+
</div>
97+
<!-- ======= START OF BOTTOM NAVBAR ====== -->
98+
<div class="bottomNav"><a name="navbar.bottom">
99+
<!-- -->
100+
</a>
101+
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
102+
<a name="navbar.bottom.firstrow">
103+
<!-- -->
104+
</a>
105+
<ul class="navList" title="Navigation">
106+
<li><a href="retrofit2/adapter/guava/package-summary.html">Package</a></li>
107+
<li>Class</li>
108+
<li><a href="overview-tree.html">Tree</a></li>
109+
<li class="navBarCell1Rev">Deprecated</li>
110+
<li><a href="index-all.html">Index</a></li>
111+
<li><a href="help-doc.html">Help</a></li>
112+
</ul>
113+
</div>
114+
<div class="subNav">
115+
<ul class="navList">
116+
<li>Prev</li>
117+
<li>Next</li>
118+
</ul>
119+
<ul class="navList">
120+
<li><a href="index.html?deprecated-list.html" target="_top">Frames</a></li>
121+
<li><a href="deprecated-list.html" target="_top">No&nbsp;Frames</a></li>
122+
</ul>
123+
<ul class="navList" id="allclasses_navbar_bottom">
124+
<li><a href="allclasses-noframe.html">All&nbsp;Classes</a></li>
125+
</ul>
126+
<div>
127+
<script type="text/javascript"><!--
128+
allClassesLink = document.getElementById("allclasses_navbar_bottom");
129+
if(window==top) {
130+
allClassesLink.style.display = "block";
131+
}
132+
else {
133+
allClassesLink.style.display = "none";
134+
}
135+
//-->
136+
</script>
137+
</div>
138+
<a name="skip.navbar.bottom">
139+
<!-- -->
140+
</a></div>
141+
<!-- ======== END OF BOTTOM NAVBAR ======= -->
142+
</body>
143+
</html>

0 commit comments

Comments
 (0)