Skip to content

Commit fa989ca

Browse files
author
Docusaurus bot
committed
Deploy website
Deploy website version based on 5f223b2
1 parent 73f4068 commit fa989ca

7 files changed

Lines changed: 7 additions & 7 deletions

File tree

docs/benchmarks.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,4 +76,4 @@
7676
edit-and-test workflows. The compiler plugin is primarily intended to be
7777
enabled in custom CI jobs to upload SCIP indexes.</li>
7878
</ul>
79-
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/scip-java/docs/design.html"><span class="arrow-prev"></span><span>Design</span></a></div></div></div><nav class="onPageNav"></nav></div><footer class="nav-footer" id="footer" style="background-color:#664100"><section class="sitemap"><a href="/scip-java/" class="nav-home"><img src="/scip-java/img/scip-java.png" alt="scip-java" width="66" height="58"/></a><div><h5>Docs</h5><a href="/scip-java/docs/installation.html">Get started</a></div><div><h5>Community</h5><a href="https://discord.gg/hJbyNrRJWr" target="_blank">Chat on Discord</a></div><div><h5>More</h5><a href="https://github.com/sourcegraph/scip-java" target="_blank">GitHub</a></div></section><section class="copyright">Copyright © 2025 scip-java developers</section></footer></div></body></html>
79+
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/scip-java/docs/design.html"><span class="arrow-prev"></span><span>Design</span></a></div></div></div><nav class="onPageNav"></nav></div><footer class="nav-footer" id="footer" style="background-color:#664100"><section class="sitemap"><a href="/scip-java/" class="nav-home"><img src="/scip-java/img/scip-java.png" alt="scip-java" width="66" height="58"/></a><div><h5>Docs</h5><a href="/scip-java/docs/installation.html">Get started</a></div><div><h5>Community</h5><a href="https://discord.gg/hJbyNrRJWr" target="_blank">Chat on Discord</a></div><div><h5>More</h5><a href="https://github.com/sourcegraph/scip-java" target="_blank">GitHub</a></div></section><section class="copyright">Copyright © 2026 scip-java developers</section></footer></div></body></html>

docs/contributing.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,4 +140,4 @@ <h2><a class="anchor" aria-hidden="true" id="tests-are-written-in-scala"></a><a
140140
string literals, but they're not supported in Java 8, which is supported by
141141
scip-java.</li>
142142
</ul>
143-
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/scip-java/docs/manual-configuration.html"><span class="arrow-prev"></span><span>Manual configuration</span></a><a class="docs-next button" href="/scip-java/docs/design.html"><span>Design</span><span class="arrow-next"></span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#system-dependencies">System dependencies</a></li><li><a href="#project-structure">Project structure</a></li><li><a href="#helpful-commands">Helpful commands</a></li><li><a href="#import-the-project-into-intellij">Import the project into IntelliJ</a></li><li><a href="#importing-the-project-with-metals">Importing the project with Metals</a></li><li><a href="#tests-are-written-in-scala">Tests are written in Scala</a></li></ul></nav></div><footer class="nav-footer" id="footer" style="background-color:#664100"><section class="sitemap"><a href="/scip-java/" class="nav-home"><img src="/scip-java/img/scip-java.png" alt="scip-java" width="66" height="58"/></a><div><h5>Docs</h5><a href="/scip-java/docs/installation.html">Get started</a></div><div><h5>Community</h5><a href="https://discord.gg/hJbyNrRJWr" target="_blank">Chat on Discord</a></div><div><h5>More</h5><a href="https://github.com/sourcegraph/scip-java" target="_blank">GitHub</a></div></section><section class="copyright">Copyright © 2025 scip-java developers</section></footer></div></body></html>
143+
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/scip-java/docs/manual-configuration.html"><span class="arrow-prev"></span><span>Manual configuration</span></a><a class="docs-next button" href="/scip-java/docs/design.html"><span>Design</span><span class="arrow-next"></span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#system-dependencies">System dependencies</a></li><li><a href="#project-structure">Project structure</a></li><li><a href="#helpful-commands">Helpful commands</a></li><li><a href="#import-the-project-into-intellij">Import the project into IntelliJ</a></li><li><a href="#importing-the-project-with-metals">Importing the project with Metals</a></li><li><a href="#tests-are-written-in-scala">Tests are written in Scala</a></li></ul></nav></div><footer class="nav-footer" id="footer" style="background-color:#664100"><section class="sitemap"><a href="/scip-java/" class="nav-home"><img src="/scip-java/img/scip-java.png" alt="scip-java" width="66" height="58"/></a><div><h5>Docs</h5><a href="/scip-java/docs/installation.html">Get started</a></div><div><h5>Community</h5><a href="https://discord.gg/hJbyNrRJWr" target="_blank">Chat on Discord</a></div><div><h5>More</h5><a href="https://github.com/sourcegraph/scip-java" target="_blank">GitHub</a></div></section><section class="copyright">Copyright © 2026 scip-java developers</section></footer></div></body></html>

docs/design.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,4 +100,4 @@ <h3><a class="anchor" aria-hidden="true" id="why-semanticdb"></a><a href="#why-s
100100
from a variety of different inputs, and will be helpful for scip-java in the
101101
future to unblock cross-repository navigation.</li>
102102
</ul>
103-
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/scip-java/docs/contributing.html"><span class="arrow-prev"></span><span>Guide</span></a><a class="docs-next button" href="/scip-java/docs/benchmarks.html"><span>Benchmarks</span><span class="arrow-next"></span></a></div></div></div><nav class="onPageNav"></nav></div><footer class="nav-footer" id="footer" style="background-color:#664100"><section class="sitemap"><a href="/scip-java/" class="nav-home"><img src="/scip-java/img/scip-java.png" alt="scip-java" width="66" height="58"/></a><div><h5>Docs</h5><a href="/scip-java/docs/installation.html">Get started</a></div><div><h5>Community</h5><a href="https://discord.gg/hJbyNrRJWr" target="_blank">Chat on Discord</a></div><div><h5>More</h5><a href="https://github.com/sourcegraph/scip-java" target="_blank">GitHub</a></div></section><section class="copyright">Copyright © 2025 scip-java developers</section></footer></div></body></html>
103+
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/scip-java/docs/contributing.html"><span class="arrow-prev"></span><span>Guide</span></a><a class="docs-next button" href="/scip-java/docs/benchmarks.html"><span>Benchmarks</span><span class="arrow-next"></span></a></div></div></div><nav class="onPageNav"></nav></div><footer class="nav-footer" id="footer" style="background-color:#664100"><section class="sitemap"><a href="/scip-java/" class="nav-home"><img src="/scip-java/img/scip-java.png" alt="scip-java" width="66" height="58"/></a><div><h5>Docs</h5><a href="/scip-java/docs/installation.html">Get started</a></div><div><h5>Community</h5><a href="https://discord.gg/hJbyNrRJWr" target="_blank">Chat on Discord</a></div><div><h5>More</h5><a href="https://github.com/sourcegraph/scip-java" target="_blank">GitHub</a></div></section><section class="copyright">Copyright © 2026 scip-java developers</section></footer></div></body></html>

docs/getting-started.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -492,4 +492,4 @@ <h4><a class="anchor" aria-hidden="true" id="manual---select"></a><a href="#manu
492492
<span class="hljs-comment"># 3. Upload SCIP index to Sourcegraph</span>
493493
src code-intel upload # requires index.scip file <span class="hljs-keyword">to</span> exist
494494
</code></pre>
495-
</span></div></article></div><div class="docs-prevnext"><a class="docs-next button" href="/scip-java/docs/manual-configuration.html"><span>Manual configuration</span><span class="arrow-next"></span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#install-scip-java">Install <code>scip-java</code></a><ul class="toc-headings"><li><a href="#docker-image">Docker image</a></li><li><a href="#java-launcher">Java launcher</a></li><li><a href="#java-fat-jar">Java fat jar</a></li><li><a href="#java-library">Java library</a></li></ul></li><li><a href="#run-scip-java-index">Run <code>scip-java index</code></a></li><li><a href="#supported-programming-languages">Supported programming languages</a><ul class="toc-headings"><li><a href="#java">Java</a></li><li><a href="#scala">Scala</a></li><li><a href="#kotlin">Kotlin</a></li></ul></li><li><a href="#supported-build-tools">Supported build tools</a><ul class="toc-headings"><li><a href="#automatic-configuration">Automatic configuration</a></li><li><a href="#manual-configuration">Manual configuration</a></li><li><a href="#gradle">Gradle</a></li><li><a href="#maven">Maven</a></li><li><a href="#sbt">sbt</a></li><li><a href="#mill">Mill</a></li><li><a href="#bazel">Bazel</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer" style="background-color:#664100"><section class="sitemap"><a href="/scip-java/" class="nav-home"><img src="/scip-java/img/scip-java.png" alt="scip-java" width="66" height="58"/></a><div><h5>Docs</h5><a href="/scip-java/docs/installation.html">Get started</a></div><div><h5>Community</h5><a href="https://discord.gg/hJbyNrRJWr" target="_blank">Chat on Discord</a></div><div><h5>More</h5><a href="https://github.com/sourcegraph/scip-java" target="_blank">GitHub</a></div></section><section class="copyright">Copyright © 2025 scip-java developers</section></footer></div></body></html>
495+
</span></div></article></div><div class="docs-prevnext"><a class="docs-next button" href="/scip-java/docs/manual-configuration.html"><span>Manual configuration</span><span class="arrow-next"></span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#install-scip-java">Install <code>scip-java</code></a><ul class="toc-headings"><li><a href="#docker-image">Docker image</a></li><li><a href="#java-launcher">Java launcher</a></li><li><a href="#java-fat-jar">Java fat jar</a></li><li><a href="#java-library">Java library</a></li></ul></li><li><a href="#run-scip-java-index">Run <code>scip-java index</code></a></li><li><a href="#supported-programming-languages">Supported programming languages</a><ul class="toc-headings"><li><a href="#java">Java</a></li><li><a href="#scala">Scala</a></li><li><a href="#kotlin">Kotlin</a></li></ul></li><li><a href="#supported-build-tools">Supported build tools</a><ul class="toc-headings"><li><a href="#automatic-configuration">Automatic configuration</a></li><li><a href="#manual-configuration">Manual configuration</a></li><li><a href="#gradle">Gradle</a></li><li><a href="#maven">Maven</a></li><li><a href="#sbt">sbt</a></li><li><a href="#mill">Mill</a></li><li><a href="#bazel">Bazel</a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer" style="background-color:#664100"><section class="sitemap"><a href="/scip-java/" class="nav-home"><img src="/scip-java/img/scip-java.png" alt="scip-java" width="66" height="58"/></a><div><h5>Docs</h5><a href="/scip-java/docs/installation.html">Get started</a></div><div><h5>Community</h5><a href="https://discord.gg/hJbyNrRJWr" target="_blank">Chat on Discord</a></div><div><h5>More</h5><a href="https://github.com/sourcegraph/scip-java" target="_blank">GitHub</a></div></section><section class="copyright">Copyright © 2026 scip-java developers</section></footer></div></body></html>

docs/manual-configuration.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -223,4 +223,4 @@ <h2><a class="anchor" aria-hidden="true" id="step-5-generate-scip-index-from-sem
223223
❯ file index.scip
224224
index.scip: JSON data
225225
</code></pre>
226-
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/scip-java/docs/getting-started.html"><span class="arrow-prev"></span><span>Getting started</span></a><a class="docs-next button" href="/scip-java/docs/contributing.html"><span>Guide</span><span class="arrow-next"></span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#overview">Overview</a></li><li><a href="#step-1-add-semanticdb-compiler-plugin-to-the-classpath">Step 1: Add SemanticDB compiler plugin to the classpath</a></li><li><a href="#step-2-enable--xpluginsemanticdb-compiler-option">Step 2: Enable <code>-Xplugin:semanticdb</code> compiler option</a></li><li><a href="#step-3-compile-the-codebase">Step 3: Compile the codebase</a></li><li><a href="#step-4-optional-enable-cross-repository-navigation">Step 4 (optional): Enable cross-repository navigation</a><ul class="toc-headings"><li><a href="#maven-plugin">Maven plugin</a></li></ul></li><li><a href="#step-5-generate-scip-index-from-semanticdb-files">Step 5: Generate SCIP index from SemanticDB files</a></li></ul></nav></div><footer class="nav-footer" id="footer" style="background-color:#664100"><section class="sitemap"><a href="/scip-java/" class="nav-home"><img src="/scip-java/img/scip-java.png" alt="scip-java" width="66" height="58"/></a><div><h5>Docs</h5><a href="/scip-java/docs/installation.html">Get started</a></div><div><h5>Community</h5><a href="https://discord.gg/hJbyNrRJWr" target="_blank">Chat on Discord</a></div><div><h5>More</h5><a href="https://github.com/sourcegraph/scip-java" target="_blank">GitHub</a></div></section><section class="copyright">Copyright © 2025 scip-java developers</section></footer></div></body></html>
226+
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/scip-java/docs/getting-started.html"><span class="arrow-prev"></span><span>Getting started</span></a><a class="docs-next button" href="/scip-java/docs/contributing.html"><span>Guide</span><span class="arrow-next"></span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#overview">Overview</a></li><li><a href="#step-1-add-semanticdb-compiler-plugin-to-the-classpath">Step 1: Add SemanticDB compiler plugin to the classpath</a></li><li><a href="#step-2-enable--xpluginsemanticdb-compiler-option">Step 2: Enable <code>-Xplugin:semanticdb</code> compiler option</a></li><li><a href="#step-3-compile-the-codebase">Step 3: Compile the codebase</a></li><li><a href="#step-4-optional-enable-cross-repository-navigation">Step 4 (optional): Enable cross-repository navigation</a><ul class="toc-headings"><li><a href="#maven-plugin">Maven plugin</a></li></ul></li><li><a href="#step-5-generate-scip-index-from-semanticdb-files">Step 5: Generate SCIP index from SemanticDB files</a></li></ul></nav></div><footer class="nav-footer" id="footer" style="background-color:#664100"><section class="sitemap"><a href="/scip-java/" class="nav-home"><img src="/scip-java/img/scip-java.png" alt="scip-java" width="66" height="58"/></a><div><h5>Docs</h5><a href="/scip-java/docs/installation.html">Get started</a></div><div><h5>Community</h5><a href="https://discord.gg/hJbyNrRJWr" target="_blank">Chat on Discord</a></div><div><h5>More</h5><a href="https://github.com/sourcegraph/scip-java" target="_blank">GitHub</a></div></section><section class="copyright">Copyright © 2026 scip-java developers</section></footer></div></body></html>

en/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@
66
</span></div></h2><div><span><p>Run the <code>scip-java</code> command-line tool at the root of your Gradle/Maven/sbt build to generate an SCIP index. No manual configuration needed.</p>
77
</span></div></div></div></div></div></div><div class="container paddingBottom paddingTop"><div class="wrapper"><div class="gridBlock"><div class="blockElement imageAlignSide imageAlignRight twoByGridBlock"><div class="blockContent"><h2><div><span><p>Low overhead</p>
88
</span></div></h2><div><span><p>Indexing a repository should be roughly as fast as compiling all of the sources in the repository.</p>
9-
</span></div></div><div class="blockImage"><img src="https://user-images.githubusercontent.com/1408093/109820240-1dccbd00-7c35-11eb-8a87-6b1850687e28.png"/></div></div></div></div></div></div></div><footer class="nav-footer" id="footer" style="background-color:#664100"><section class="sitemap"><a href="/scip-java/" class="nav-home"><img src="/scip-java/img/scip-java.png" alt="scip-java" width="66" height="58"/></a><div><h5>Docs</h5><a href="/scip-java/docs/installation.html">Get started</a></div><div><h5>Community</h5><a href="https://discord.gg/hJbyNrRJWr" target="_blank">Chat on Discord</a></div><div><h5>More</h5><a href="https://github.com/sourcegraph/scip-java" target="_blank">GitHub</a></div></section><section class="copyright">Copyright © 2025 scip-java developers</section></footer></div></body></html>
9+
</span></div></div><div class="blockImage"><img src="https://user-images.githubusercontent.com/1408093/109820240-1dccbd00-7c35-11eb-8a87-6b1850687e28.png"/></div></div></div></div></div></div></div><footer class="nav-footer" id="footer" style="background-color:#664100"><section class="sitemap"><a href="/scip-java/" class="nav-home"><img src="/scip-java/img/scip-java.png" alt="scip-java" width="66" height="58"/></a><div><h5>Docs</h5><a href="/scip-java/docs/installation.html">Get started</a></div><div><h5>Community</h5><a href="https://discord.gg/hJbyNrRJWr" target="_blank">Chat on Discord</a></div><div><h5>More</h5><a href="https://github.com/sourcegraph/scip-java" target="_blank">GitHub</a></div></section><section class="copyright">Copyright © 2026 scip-java developers</section></footer></div></body></html>

index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@
66
</span></div></h2><div><span><p>Run the <code>scip-java</code> command-line tool at the root of your Gradle/Maven/sbt build to generate an SCIP index. No manual configuration needed.</p>
77
</span></div></div></div></div></div></div><div class="container paddingBottom paddingTop"><div class="wrapper"><div class="gridBlock"><div class="blockElement imageAlignSide imageAlignRight twoByGridBlock"><div class="blockContent"><h2><div><span><p>Low overhead</p>
88
</span></div></h2><div><span><p>Indexing a repository should be roughly as fast as compiling all of the sources in the repository.</p>
9-
</span></div></div><div class="blockImage"><img src="https://user-images.githubusercontent.com/1408093/109820240-1dccbd00-7c35-11eb-8a87-6b1850687e28.png"/></div></div></div></div></div></div></div><footer class="nav-footer" id="footer" style="background-color:#664100"><section class="sitemap"><a href="/scip-java/" class="nav-home"><img src="/scip-java/img/scip-java.png" alt="scip-java" width="66" height="58"/></a><div><h5>Docs</h5><a href="/scip-java/docs/installation.html">Get started</a></div><div><h5>Community</h5><a href="https://discord.gg/hJbyNrRJWr" target="_blank">Chat on Discord</a></div><div><h5>More</h5><a href="https://github.com/sourcegraph/scip-java" target="_blank">GitHub</a></div></section><section class="copyright">Copyright © 2025 scip-java developers</section></footer></div></body></html>
9+
</span></div></div><div class="blockImage"><img src="https://user-images.githubusercontent.com/1408093/109820240-1dccbd00-7c35-11eb-8a87-6b1850687e28.png"/></div></div></div></div></div></div></div><footer class="nav-footer" id="footer" style="background-color:#664100"><section class="sitemap"><a href="/scip-java/" class="nav-home"><img src="/scip-java/img/scip-java.png" alt="scip-java" width="66" height="58"/></a><div><h5>Docs</h5><a href="/scip-java/docs/installation.html">Get started</a></div><div><h5>Community</h5><a href="https://discord.gg/hJbyNrRJWr" target="_blank">Chat on Discord</a></div><div><h5>More</h5><a href="https://github.com/sourcegraph/scip-java" target="_blank">GitHub</a></div></section><section class="copyright">Copyright © 2026 scip-java developers</section></footer></div></body></html>

0 commit comments

Comments
 (0)