aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorNicholas Bennett <nicholas.bennett@qt.io>2024-10-01 15:31:37 +0300
committerNicholas Bennett <nicholas.bennett@qt.io>2024-10-21 10:43:42 +0000
commite2543bc1ea8ca39b58a8c4ef1ebdae3d221f5c6a (patch)
tree26685094c175c8f0b13d63f7b31a20fa2502bc60
parent35f87b6deda46fe62b27a814213ecc7fe13161cb (diff)
Docs: Add initial docs project and skeleton doc source pages
I added the necessary CMakelists for the documentation build system. I created the initial qdocconf files as per the usual module doc setup. I added a basic set of documentation pages, which was not exhaustive. [ChangeLog][Third-Party Code] Fixes: QTTA-182 Task-number: QTTA-176 Change-Id: Ib8a38ff9ee5fcb83a1a930f9bfe3ea0c7a37ce5e Reviewed-by: Ville Voutilainen <ville.voutilainen@qt.io>
-rw-r--r--.version.conf1
-rw-r--r--CMakeLists.txt14
-rw-r--r--LICENSES/Apache-2.0.txt (renamed from LICENSE)0
-rw-r--r--doc/CMakeLists.txt1
-rw-r--r--doc/config/CMakeLists.txt13
-rw-r--r--doc/config/online/qtjenny.qdocconf5
-rw-r--r--doc/config/online/style/qt-sidebar.html23
-rw-r--r--doc/config/qtjenny-project.qdocconf47
-rw-r--r--doc/config/qtjenny.qdocconf2
-rw-r--r--doc/src/concepts.qdoc17
-rw-r--r--doc/src/configuration.qdoc36
-rw-r--r--doc/src/external-resources.qdoc7
-rw-r--r--doc/src/installation.qdoc15
-rw-r--r--doc/src/qt-jenny.qdoc46
-rw-r--r--doc/src/whatsnew.qdoc16
-rw-r--r--qt_attribution.json12
16 files changed, 255 insertions, 0 deletions
diff --git a/.version.conf b/.version.conf
new file mode 100644
index 0000000..fd38af6
--- /dev/null
+++ b/.version.conf
@@ -0,0 +1 @@
+set(QT_REPO_MODULE_VERSION "1.1.0")
diff --git a/CMakeLists.txt b/CMakeLists.txt
new file mode 100644
index 0000000..3a7b636
--- /dev/null
+++ b/CMakeLists.txt
@@ -0,0 +1,14 @@
+cmake_minimum_required(VERSION 3.16)
+include(.version.conf)
+project(qtg_DOC
+ VERSION "${QT_REPO_MODULE_VERSION}"
+ DESCRIPTION "Qt Jenny"
+ HOMEPAGE_URL "https://qt.io/"
+ LANGUAGES CXX C
+)
+
+find_package(Qt6 CONFIG REQUIRED COMPONENTS BuildInternals Core)
+
+qt_build_repo_begin()
+add_subdirectory(doc)
+qt_build_repo_end()
diff --git a/LICENSE b/LICENSES/Apache-2.0.txt
index 8405e89..8405e89 100644
--- a/LICENSE
+++ b/LICENSES/Apache-2.0.txt
diff --git a/doc/CMakeLists.txt b/doc/CMakeLists.txt
new file mode 100644
index 0000000..9040988
--- /dev/null
+++ b/doc/CMakeLists.txt
@@ -0,0 +1 @@
+add_subdirectory(config)
diff --git a/doc/config/CMakeLists.txt b/doc/config/CMakeLists.txt
new file mode 100644
index 0000000..5074911
--- /dev/null
+++ b/doc/config/CMakeLists.txt
@@ -0,0 +1,13 @@
+add_library(QtJenny INTERFACE)
+target_link_libraries(QtJenny INTERFACE
+ Qt::Core
+ Qt::CorePrivate
+ Qt::Gui
+ Qt::Qml
+)
+
+set(DOC_CONF "online/qtjenny.qdocconf")
+
+qt_internal_add_docs(QtJenny
+ ${DOC_CONF}
+)
diff --git a/doc/config/online/qtjenny.qdocconf b/doc/config/online/qtjenny.qdocconf
new file mode 100644
index 0000000..f9f0c4b
--- /dev/null
+++ b/doc/config/online/qtjenny.qdocconf
@@ -0,0 +1,5 @@
+include($QT_INSTALL_DOCS/global/qt-module-defaults-online.qdocconf)
+include(../qtjenny-project.qdocconf)
+
+# Sidebar for online documentation build
+HTML.stylesheets += style/qt-sidebar.html
diff --git a/doc/config/online/style/qt-sidebar.html b/doc/config/online/style/qt-sidebar.html
new file mode 100644
index 0000000..2c6c6e7
--- /dev/null
+++ b/doc/config/online/style/qt-sidebar.html
@@ -0,0 +1,23 @@
+<div class="sectionlist normallist">
+ <div class="heading">
+ <h2>Overviews</h2>
+ </div>
+ <ul>
+ <li><a href="index.html#features">Features</a></li>
+ <li><a href="concepts.html">Concepts</a></li>
+ <li><a href="qtjenny-configuration.html">Configuration</a></li>
+ </ul>
+</div>
+<div class="sectionlist normallist">
+ <div class="heading">
+ <h2>Getting Started</h2>
+ </div>
+ <ul>
+ <li><a href="qtjenny-installation.html">Installation</a></li>
+ </ul>
+</div>
+<div class="sectionlist normallist">
+ <div class="heading">
+ <h2><a href="whatsnew.html">What's New</a></h2>
+ </div>
+</div>
diff --git a/doc/config/qtjenny-project.qdocconf b/doc/config/qtjenny-project.qdocconf
new file mode 100644
index 0000000..7d7f052
--- /dev/null
+++ b/doc/config/qtjenny-project.qdocconf
@@ -0,0 +1,47 @@
+includepaths += .
+
+project = QtJenny
+description = Qt Jenny
+version = $QT_VER
+url = https://doc.qt.io/qtjenny
+
+sourcedirs += ../src
+imagedirs += ../images
+
+qhp.projects = QtJenny
+
+qhp.QtJenny.file = qtjenny.qhp
+qhp.QtJenny.namespace = org.qt-project.qtjenny.$QT_VERSION_TAG
+qhp.QtJenny.virtualFolder = qtjenny
+qhp.QtJenny.indexTitle = Qt Jenny
+qhp.QtJenny.indexRoot =
+
+qhp.QtJenny.filterAttributes = qtjenny $QT_VERSION qtrefdoc
+qhp.QtJenny.customFilters.Qt.name = QtJenny $QT_VERSION
+qhp.QtJenny.customFilters.Qt.filterAttributes = qtjenny $QT_VERSION
+
+tagfile = qtjenny.tags
+
+#Check dependencies, linking using external URLs for now
+depends += \
+ qtdoc \
+ qdoc \
+ qtcore \
+ qtgui \
+ qtquick \
+ qtqml \
+ qtqmlmodels \
+ qtcmake \
+ qtquickcontrols
+
+buildversion = "Qt Jenny $QT_VER"
+
+navigation.homepage = "Qt Jenny"
+navigation.hometitle = "Qt Jenny"
+
+macro.majorversion = "1"
+macro.minorversion = "1.0"
+macro.patchversion = "1.0.0"
+
+# Fail the documentation build if there are more warnings than the limit
+warninglimit = 0
diff --git a/doc/config/qtjenny.qdocconf b/doc/config/qtjenny.qdocconf
new file mode 100644
index 0000000..8d0d347
--- /dev/null
+++ b/doc/config/qtjenny.qdocconf
@@ -0,0 +1,2 @@
+include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf)
+include(qtjenny-project.qdocconf)
diff --git a/doc/src/concepts.qdoc b/doc/src/concepts.qdoc
new file mode 100644
index 0000000..0885264
--- /dev/null
+++ b/doc/src/concepts.qdoc
@@ -0,0 +1,17 @@
+// Copyright (C) 2024 The Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
+/*!
+\page concepts.html
+\title Concepts and Architecture
+
+Qt Jenny depends on the following set of key concepts:
+
+\list
+ \li The \l{Gradle} build tool.
+ \li
+ \li
+ \li
+ \li
+ \li
+\endlist
+*/
diff --git a/doc/src/configuration.qdoc b/doc/src/configuration.qdoc
new file mode 100644
index 0000000..122ac32
--- /dev/null
+++ b/doc/src/configuration.qdoc
@@ -0,0 +1,36 @@
+// Copyright (C) 2024 The Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
+/*!
+\page qtjenny-configuration.html
+\title Configuration
+
+\section1 Runtime Configuration
+
+The following environment variables are supported for runtime configurations:
+
+\table
+ \header
+ \li Environment Variable
+ \li Description
+ \row
+ \li
+ \li
+ \row
+ \li
+ \li
+ \row
+ \li
+ \li
+ \row
+ \li
+ \li
+ \row
+ \li
+ \li
+\endtable
+
+\section2 Logging
+\target logging_configuration
+
+
+*/
diff --git a/doc/src/external-resources.qdoc b/doc/src/external-resources.qdoc
new file mode 100644
index 0000000..75236d8
--- /dev/null
+++ b/doc/src/external-resources.qdoc
@@ -0,0 +1,7 @@
+// Copyright (C) 2021 The Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
+
+/*!
+ \externalpage https://gradle.org/
+ \title Gradle
+*/
diff --git a/doc/src/installation.qdoc b/doc/src/installation.qdoc
new file mode 100644
index 0000000..4c1cdf6
--- /dev/null
+++ b/doc/src/installation.qdoc
@@ -0,0 +1,15 @@
+// Copyright (C) 2024 The Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
+/*!
+\page qtjenny-installation.html
+\title Installation
+
+To install Qt Jenny:
+
+\section1 Getting Qt Jenny
+
+\section1 Installing It
+
+
+
+*/
diff --git a/doc/src/qt-jenny.qdoc b/doc/src/qt-jenny.qdoc
new file mode 100644
index 0000000..d2fab0d
--- /dev/null
+++ b/doc/src/qt-jenny.qdoc
@@ -0,0 +1,46 @@
+// Copyright (C) 2024 The Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
+
+/*!
+ \page index.html
+ \title Qt Jenny: Java Code Generator
+ \brief Overview of Qt Jenny
+ \target Qt Jenny
+
+ Qt Jenny translates Java APIs to C++ wrappers.
+
+ \section1 Features
+
+ Qt Jenny's features:
+ \list
+ \li
+ //! TODO: add a list of features
+ \endlist
+
+ See \l{Get Started with Qt Jenny} to start creating your C++ wrappers.
+
+ \section1 How Qt Jenny works
+
+ Qt Jenny translates Java APIs to C++ wrappers by...
+ //! TODO: explain this
+
+ \image qtjenny-overview.png "Qt Jenny Architecture"
+
+ \note There is no compatibility guarantee for the autogenerated code. This
+ means that even application code that uses the autogenerated code is only
+ guaranteed to work with the Qt Jenny version it was developed
+ against. We try to keep the API source compatible for as long as possible.
+
+
+ \section1 Reference
+
+ //! TODO: Are there any references around code generation the reader could benefit from
+
+ \section1 Licenses and Attributions
+
+ Qt Jenny potentially contains third-party modules under the following
+ permissive licenses:
+
+ \generatelist{groupsbymodule attributions-qtjenny}
+
+*/
diff --git a/doc/src/whatsnew.qdoc b/doc/src/whatsnew.qdoc
new file mode 100644
index 0000000..6ff7348
--- /dev/null
+++ b/doc/src/whatsnew.qdoc
@@ -0,0 +1,16 @@
+// Copyright (C) 2024 The Qt Company Ltd.
+// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
+/*!
+\page whatsnew.html
+\title What's New in Qt Jenny
+
+The following page describes new features by version
+
+\section1 Qt Jenny 1.0
+
+\list
+ \li
+ //! TODO: add list of features
+\endlist
+
+*/
diff --git a/qt_attribution.json b/qt_attribution.json
new file mode 100644
index 0000000..14a97e1
--- /dev/null
+++ b/qt_attribution.json
@@ -0,0 +1,12 @@
+{
+ "Id": "qtjenny-gradle",
+ "Name": "Gradle Build Tool",
+ "QDocModule": "qtjenny",
+ "QtParts": [ "tools" ],
+ "QtUsage": "Used in Qt Jenny",
+ "Homepage": "https://gradle.org/",
+ "License": "Apache 2.0",
+ "LicenseId": "urn:dje:license:public-domain",
+ "LicenseFile": "LICENSES/Apache-2.0.txt",
+ "Copyright": ["Copyright 2015 the original author or authors"]
+}