You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pdfbox.apache.org by ms...@apache.org on 2022/07/29 07:12:29 UTC
[pdfbox-docs] branch master updated: PDFBOX-5475: use javadoc.io as a base for API docs; make URLs dynamic for documentation
This is an automated email from the ASF dual-hosted git repository.
msahyoun pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pdfbox-docs.git
The following commit(s) were added to refs/heads/master by this push:
new 33163223 PDFBOX-5475: use javadoc.io as a base for API docs; make URLs dynamic for documentation
33163223 is described below
commit 331632236eedeab4909a3d2dd119646750aa35dd
Author: Maruan Sahyoun <sa...@fileaffairs.de>
AuthorDate: Fri Jul 29 09:11:34 2022 +0200
PDFBOX-5475: use javadoc.io as a base for API docs; make URLs dynamic for documentation
---
content/1.8/1.8.11tydata.js | 1 +
content/1.8/javadoc.md | 27 ----------------------
content/2.0/2.0.11tydata.js | 1 +
content/2.0/javadoc.md | 25 --------------------
.../{1.8/1.8.11tydata.js => 3.0/3.0.11tydata.js} | 3 ++-
content/_layouts/default.html | 5 ++--
content/_layouts/documentation.html | 5 ++++
7 files changed, 12 insertions(+), 55 deletions(-)
diff --git a/content/1.8/1.8.11tydata.js b/content/1.8/1.8.11tydata.js
index 12799ca7..ca21f72e 100644
--- a/content/1.8/1.8.11tydata.js
+++ b/content/1.8/1.8.11tydata.js
@@ -1,5 +1,6 @@
module.exports = {
eleventyComputed: {
+ release: '1.8.16',
eleventyNavigation: {
version: '1.8',
key: data => data.eleventyNavigation && data.eleventyNavigation.key ? data.eleventyNavigation.key : data.title,
diff --git a/content/1.8/javadoc.md b/content/1.8/javadoc.md
deleted file mode 100644
index bf6c2197..00000000
--- a/content/1.8/javadoc.md
+++ /dev/null
@@ -1,27 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-layout: documentation
-title: API Docs
-
-permalink: false
-
-eleventyNavigation:
- order: 5
- url: https://pdfbox.apache.org/docs/1.8.13/javadocs/
----
\ No newline at end of file
diff --git a/content/2.0/2.0.11tydata.js b/content/2.0/2.0.11tydata.js
index 345999c7..27ada745 100644
--- a/content/2.0/2.0.11tydata.js
+++ b/content/2.0/2.0.11tydata.js
@@ -1,5 +1,6 @@
module.exports = {
eleventyComputed: {
+ release: '2.0.26',
eleventyNavigation: {
version: '2.0',
key: data => data.eleventyNavigation && data.eleventyNavigation.key ? data.eleventyNavigation.key : data.title,
diff --git a/content/2.0/javadoc.md b/content/2.0/javadoc.md
deleted file mode 100644
index 3c0da50f..00000000
--- a/content/2.0/javadoc.md
+++ /dev/null
@@ -1,25 +0,0 @@
----
-license: Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
-
-layout: documentation
-title: API Docs
-permalink: false
-eleventyNavigation:
- order: 7
- url: https://pdfbox.apache.org/docs/2.0.13/javadocs/
----
\ No newline at end of file
diff --git a/content/1.8/1.8.11tydata.js b/content/3.0/3.0.11tydata.js
similarity index 84%
copy from content/1.8/1.8.11tydata.js
copy to content/3.0/3.0.11tydata.js
index 12799ca7..8c0caec3 100644
--- a/content/1.8/1.8.11tydata.js
+++ b/content/3.0/3.0.11tydata.js
@@ -1,7 +1,8 @@
module.exports = {
eleventyComputed: {
+ release: '3.0.0-alpha3',
eleventyNavigation: {
- version: '1.8',
+ version: '3.0',
key: data => data.eleventyNavigation && data.eleventyNavigation.key ? data.eleventyNavigation.key : data.title,
parent: data => data.parent
},
diff --git a/content/_layouts/default.html b/content/_layouts/default.html
index eeeb7beb..81e67411 100644
--- a/content/_layouts/default.html
+++ b/content/_layouts/default.html
@@ -47,6 +47,7 @@
<a href="#">3.0 (Pre Release)</a>
<ul>
<li><a href="/3.0/migration.html">Migration Guide</a></li>
+ <li><a href="https://javadoc.io/doc/org.apache.pdfbox/pdfbox/3.0.0-alpha3/index.html">API Docs</a></li>
</ul>
</li>
<li class="sidebar-node" id="v2-0">
@@ -64,7 +65,7 @@
</li>
<li><a href="/2.0/commandline.html">Command-Line Tools</a></li>
<li><a href="/2.0/faq.html">FAQ</a></li>
- <li><a href="/docs/2.0.13/javadocs/">API Docs</a></li>
+ <li><a href="https://javadoc.io/doc/org.apache.pdfbox/pdfbox/2.0.26/index.html">API Docs</a></li>
</ul>
</li>
<li class="sidebar-node" id="v1-8">
@@ -86,7 +87,7 @@
</ul>
</li>
<li><a href="/1.8/commandline.html">Command-Line Tools</a></li>
- <li><a href="/docs/1.8.13/javadocs/">API Docs</a></li>
+ <li><a href="https://javadoc.io/doc/org.apache.pdfbox/pdfbox/1.8.16/index.html">API Docs</a></li>
<li><a href="/1.8/faq.html">FAQ</a></li>
</ul>
</li>
diff --git a/content/_layouts/documentation.html b/content/_layouts/documentation.html
index ddad3686..22e51379 100644
--- a/content/_layouts/documentation.html
+++ b/content/_layouts/documentation.html
@@ -55,6 +55,11 @@
</li>
{%- endif -%}
{%- endfor -%}
+ <li>
+ <a href="https://javadoc.io/doc/org.apache.pdfbox/pdfbox/{{ release }}/index.html" {% if link.active %}aria-current="page"{% endif %}>
+ API Docs
+ </a>
+ </li>
</ul>
</nav>