This is an automated email from the ASF dual-hosted git repository.
slawrence pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/daffodil-site.git
The following commit(s) were added to refs/heads/main by this push:
new a47207b Remove the Scala API from the website
a47207b is described below
commit a47207b42fff262321941665d84950be7527dc2d
Author: Steve Lawrence <slawre...@apache.org>
AuthorDate: Mon Aug 11 14:25:54 2025 -0400
Remove the Scala API from the website
With the move to Scala 3 and our API written entirely in Java, there is
no way to generate scaladoc-style documentation. These changes are made:
- The update-docs workflow run during releases no longer creates a
scaladoc directory. Note that target/scala-*/unidoc now contains
javadoc because all our our API files are .java.
- Remove "Java API" and "Scala API" from the navigation bar, replacing
them with just an "API" link to the javadocs.
- For release pages 4.0.0 and newer, do not output the "Scaladoc" link
- Remove references to "Java API" and "Scala API" in the getting started
page, replacing it with "API"
---
.github/workflows/update-docs.yml | 5 ++---
site/_includes/themes/apache/_navigation.html | 3 +--
site/_layouts/release.html | 3 ++-
site/getting-started.md | 4 ++--
4 files changed, 7 insertions(+), 8 deletions(-)
diff --git a/.github/workflows/update-docs.yml
b/.github/workflows/update-docs.yml
index 21704b7..e8f1a12 100644
--- a/.github/workflows/update-docs.yml
+++ b/.github/workflows/update-docs.yml
@@ -94,9 +94,8 @@ jobs:
rm -rf $TUTORIALS_DIR
sbt unidoc
- mkdir -p $DOCS_DIR/{javadoc,scaladoc}/
- cp -R target/javaunidoc/* $DOCS_DIR/javadoc/
- cp -R target/scala-*/unidoc/* $DOCS_DIR/scaladoc/
+ mkdir -p $DOCS_DIR/javadoc/
+ cp -R target/scala-*/unidoc/* $DOCS_DIR/javadoc/
mkdir -p $TUTORIALS_DIR
cp -R tutorials/src/main/resources/* $TUTORIALS_DIR/
diff --git a/site/_includes/themes/apache/_navigation.html
b/site/_includes/themes/apache/_navigation.html
index fd726ec..1234d59 100644
--- a/site/_includes/themes/apache/_navigation.html
+++ b/site/_includes/themes/apache/_navigation.html
@@ -16,8 +16,7 @@
<ul class="dropdown-menu dropdown-left">
<li><a href="/getting-started/">Getting Started</a></li>
<li><a href="/examples/">Examples</a></li>
- <li><a href="/docs/latest/javadoc/">Java API</a></li>
- <li><a href="/docs/latest/scaladoc/">Scala API</a></li>
+ <li><a href="/docs/latest/javadoc/">API</a></li>
<li><a href="/docs/dfdl/">DFDL Specification</a></li>
<li><a href="/unsupported/">Unsupported Features</a></li>
<li><a href="/faq/">Frequently Asked Questions</a></li>
diff --git a/site/_layouts/release.html b/site/_layouts/release.html
index cb4a963..3821aa1 100644
--- a/site/_layouts/release.html
+++ b/site/_layouts/release.html
@@ -22,7 +22,8 @@ permalink: /release/release-notes-:title
<div class="row">
<div class="col-md-3 text-right" style="float: right; z-index: 3;">
<h3>Documentation</h3>
- <a href="/docs/{{ page.title }}/javadoc/">Javadoc</a> | <a href="/docs/{{
page.title }}/scaladoc/">Scaladoc</a>
+ {% assign major_version = page.title | split: '.' | first | plus: 0 %}
+ <a href="/docs/{{ page.title }}/javadoc/">Javadoc</a>{% if major_version <
4 %} | <a href="/docs/{{ page.title }}/scaladoc/">Scaladoc</a>{% endif %}
</div>
<div class="col-md-12">
diff --git a/site/getting-started.md b/site/getting-started.md
index 99e1ff0..0b73230 100644
--- a/site/getting-started.md
+++ b/site/getting-started.md
@@ -30,9 +30,9 @@ Daffodil is a library, requiring Java 8, used to convert
between fixed format da
: Linux and Windows command line tool with capabilities include parsing,
unaparsing, an interactive debugger, and more. Available via download in binary
[releases](/releases).
-[Java API](/docs/latest/javadoc) or [Scala API](/docs/latest/scaladoc)
+[API](/docs/latest/javadoc)
- : Examples for using the Java API are available on the [OpenDFDL
examples](https://github.com/OpenDFDL/examples.git) repository. Individual
[releases](/releases) describe how to include a dependency to Daffodil via
Maven and SBT.
+ : Examples for using the API in both Java and Scala are available on the
[OpenDFDL examples](https://github.com/OpenDFDL/examples.git) repository.
Individual [releases](/releases) describe how to include a dependency to
Daffodil via Maven and SBT.
[Apache NiFi Processors](https://github.com/TresysTechnology/nifi-daffodil)
