Skip to content

Commit be8e7a8

Browse files
manticore-projectswumpz
manticore-projects
and
wumpz
authored
Sphinx Website (#1624)
* Enhanced Keywords Add Keywords and document, which keywords are allowed for what purpose * Fix incorrect tests * Define Reserved Keywords explicitly Derive All Keywords from Grammar directly Generate production for Object Names (semi-) automatically Add parametrized Keyword Tests * Fix test resources * Adjust Gradle to JUnit 5 Parallel Test execution Gradle Caching Explicitly request for latest JavaCC 7.0.10 * Do not mark SpeedTest for concurrent execution * Remove unused imports * Adjust Gradle to JUnit 5 Parallel Test execution Gradle Caching Explicitly request for latest JavaCC 7.0.10 * Do not mark SpeedTest for concurrent execution * Remove unused imports * Keyword test adopt JUnit5 Update keywords * CheckStyle sanitation of method names * Merge Master * Add Jupiter Parameters dependency again * Automate the `updateKeywords` Step * Update PMD and rules * Rewrite test expected to fail * Appease Codacy * Remove broken rule warning about perfectly fine switch-case statements * Force Changes * Fix Merge Issues * Read Tokens directly from the Grammar File without invoking JTREE - read Tokens per REGEX Matcher - move Reserved Keywords from Grammar into ParserKeywordsUtils - adjust the Tests * Appease PMD/Codacy * Extract the Keywords from the Grammar by using JTRee (instead of Regex) Add some tests to ensure, that all Keywords or found * Appease Codacy/PMD * Separate UpdateKeywords Task again Including it into compileJavacc won't work since it depends on compiling the ParserKeywordUtils.java Single file compilation did not work * Clean-up the imports * Add JavaCC dependency to Maven for building ParserKeywordsUtils * Add JavaCC dependency to Maven for building ParserKeywordsUtils * Merge Upstream * Merge Master * Fixes broken PR #1524 and Commit fb6e950 * Add AST Visualization Show the Statement's Java Objects in a tree hierarchy * Sphinx Documentation Update the MANTICORE Sphinx Theme, but ignore it in GIT Add the content to the Sphinx sites Add a Gradle function to derive Stable and Snapshot version from GIT Tags Add a Gradle GIT change task Add a Gradle sphinx task Add a special Test case for illustrating the use of JSQLParser * test: Document an additional Special Oracle test success * doc: ignore the autogenerated changelog.rst in GIT * build: temporarily reduce the Code Coverage requirements Temporarily reduce the Coverage checks regarding Minimum Coverage and Maximum Missed Lines in order to get the Keywords PR accepted. We should do a major Code cleanup afterwards. * build: Clean-up the Gradle Build Prefix the Sphinx Prolog Variables with JSQLPARSER in order to allow for build the Main Website for various projects Remove some redundant version requests for PMD, CheckStyle and friends Remove JUnit-4 dependency and add HarmCrest Complete the PUBLISHING task * doc: Explain the ``updateKeywords`` Gradle Task * build: Un-escape the Unicode on the changelog file * build: Un-escape the Unicode on the changelog file * doc: Cleanup Unescape unicode characters from Git Changelog Remove obsolete code from Sphinx' conf.py * doc: Properly un-escape the Git Commit message * doc: request for `Conventional Commit` messages * doc: correctly refer to `RelObjectNameWithoutValue()` * build: upload the built files via Excec/SFTP * doc: Add an example on Token White-listing * doc: write the correct Git Repository * doc: pronounce the OVERLAPS example more * feat: make important Classes Serializable Implement Serializable for persisting via ObjectOutputStream * doc: Add the "How to Use" java code * chore: Make Serializable * fix: Non-serializable field in serializable class * build: various fixes to the Maven build file add the Keywords Documentation file to the task exclude the Sphinx files from the license header plugin fix the JavaDoc plugin options * build: add the Keywords Documentation file to the task * doc: add a page about actually Reserved Keywords * build: avoid PMD/Codacy for Sphinx Documentation * update Changelog * build: Add Sphinx GitHub Action Add a GitHub Action, which will - Install Sphinx and Extensions - Install Gradle Wrapper - Run Gradle Wrapper Task `sphinx` - Deploy the generated static HTML site to GH Pages * fix: fix a merge error, brackets * fix: remove JavaCC dependency Parse Tokens via Regex Move JavaCC Token Parser into the KeywordsTest Make JavaCC a Test Dependency only * doc: Fix Maven Artifact Version * style: Avoid throwing raw exception types. * style: Avoid throwing raw exception types. * doc: Better integration of the RR diagrams - apply neutral Sphinx theme - insert the RR diagrams into the sphinx sources - better documentation on Gradle dependencies - link GitHub repository * build: gradle, execute all Checks after Test Co-authored-by: Tobias <t.warneke@gmx.net>
1 parent a00d77a commit be8e7a8

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

67 files changed

+13666
-370
lines changed

‎.codacy.yml

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
exclude_paths:
3+
- "site/**"

‎.github/workflows/sphinx.yml

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: Sphinx Pages
2+
on: [push, workflow_dispatch]
3+
permissions: write-all
4+
jobs:
5+
docs:
6+
runs-on: ubuntu-latest
7+
steps:
8+
- uses: actions/setup-python@v4
9+
- name: Install XSLT Processor
10+
run: sudo apt-get install xsltproc sphinx-common
11+
- name: Install dependencies
12+
run: pip install sphinx_rtd_theme sphinx-book-theme myst_parser sphinx-prompt sphinx_substitution_extensions sphinx_issues sphinx_tabs pygments
13+
- name: Checkout project sources
14+
uses: actions/checkout@v2
15+
with:
16+
ref: master
17+
fetch-depth: 0
18+
- name: Setup Gradle
19+
uses: gradle/gradle-build-action@v2
20+
- name: Run build with Gradle Wrapper
21+
run: gradle sphinx
22+
- name: Deploy
23+
uses: actions/configure-pages@v2
24+
- name: Upload artifact
25+
uses: actions/upload-pages-artifact@v1
26+
with:
27+
# Upload entire repository
28+
path: 'build/sphinx'
29+
- name: Deploy to GitHub Pages
30+
id: deployment
31+
uses: actions/deploy-pages@v1

‎.gitignore

+6
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,12 @@
22
/target
33
/build
44

5+
# Sphinx Theme related stuff, which shall be downloaded separately
6+
/src/site/sphinx/_themes
7+
8+
# Exclude the Auto-generated Changelog
9+
/src/site/sphinx/changelog.rst
10+
511
# Generated by javacc-maven-plugin
612
/bin
713
/src/net

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ And this is the dependency declaration in your pom:
129129
<dependency>
130130
<groupId>com.github.jsqlparser</groupId>
131131
<artifactId>jsqlparser</artifactId>
132-
<version>4.4</version>
132+
<version>4.5</version>
133133
</dependency>
134134
```
135135

0 commit comments

Comments
 (0)