Skip to content

Commit 0f0922c

Browse files
doc: use the new Sphinx Javadoc extension
Signed-off-by: Andreas Reichel <andreas@manticore-projects.com> Signed-off-by: manticore-projects <andreas@manticore-projects.com>
1 parent fff8a08 commit 0f0922c

File tree

4 files changed

+5
-14
lines changed

4 files changed

+5
-14
lines changed

.github/workflows/ci.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ jobs:
8686
run: sudo apt-get install -y xsltproc sphinx-common
8787

8888
- name: Install Python dependencies
89-
run: pip install manticore_sphinx_theme myst_parser sphinx_substitution_extensions sphinx_issues sphinx_inline_tabs pygments
89+
run: pip install manticore_sphinx_theme sphinx_javadoc_xml myst_parser sphinx_substitution_extensions sphinx_issues sphinx_inline_tabs pygments
9090

9191
- name: Build Sphinx documentation with Gradle
9292
run: FLOATING_TOC=false ./gradlew -DFLOATING_TOC=false gitChangelogTask renderRR xslt xmldoc sphinx

.gitignore

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,10 @@
88

99
# Exclude the Auto-generated Changelog
1010
/src/site/sphinx/changelog.rst
11-
/src/site/sphinx/javadoc_stable.rst
1211
/src/site/sphinx/syntax_stable.rst
13-
/src/site/sphinx/javadoc_snapshot.rst
1412
/src/site/sphinx/syntax_snapshot.rst
13+
/src/site/sphinx/javadoc_stable.xml
14+
/src/site/sphinx/javadoc_snapshot.xml
1515

1616
# Generated by javacc-maven-plugin
1717
/bin

build.gradle

Lines changed: 1 addition & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -249,12 +249,6 @@ tasks.register('xmldoc', Javadoc) {
249249
: "xmlDoclet/javadoc_stable.xml"
250250
)
251251

252-
def rstFile = reporting.file(
253-
version.endsWith("-SNAPSHOT")
254-
? "xmlDoclet/javadoc_snapshot.rst"
255-
: "xmlDoclet/javadoc_stable.rst"
256-
)
257-
258252
source = sourceSets.main.allJava
259253
// add any generated Java sources
260254
source += fileTree(layout.buildDirectory.dir("generated/javacc").get().asFile) {
@@ -271,16 +265,12 @@ tasks.register('xmldoc', Javadoc) {
271265
options.doclet = "com.manticore.tools.xmldoclet.XmlDoclet"
272266
title = "API $version"
273267

274-
options.addBooleanOption("rst", true)
275-
if (Boolean.parseBoolean(System.getProperty("FLOATING_TOC", "true"))) {
276-
options.addBooleanOption("withFloatingToc", true)
277-
}
278268
options.addStringOption("basePackage", "net.sf.jsqlparser")
279269
options.addStringOption("filename", outFile.getName())
280270

281271
doLast {
282272
copy {
283-
from rstFile
273+
from outFile
284274
into layout.projectDirectory.dir("src/site/sphinx/").asFile
285275
}
286276
}

src/site/sphinx/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
"sphinx_substitution_extensions",
1717
"sphinx_inline_tabs",
1818
"pygments.sphinxext",
19+
"sphinx_javadoc_xml",
1920
]
2021

2122

0 commit comments

Comments
 (0)