commit c852782a13362d49fcf2f4eadf5f2e65d58e0ca7 Author: xarkam Date: Thu May 21 18:39:29 2026 +0200 Initial commit diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..2a5247d --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +build/ +.idea/ +.mypy_cache/ +.venv/ \ No newline at end of file diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..d0c3cbf --- /dev/null +++ b/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = source +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/make.bat b/make.bat new file mode 100644 index 0000000..dc1312a --- /dev/null +++ b/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=source +set BUILDDIR=build + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.https://www.sphinx-doc.org/ + exit /b 1 +) + +if "%1" == "" goto help + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..c08f5e5 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,33 @@ +alabaster==1.0.0 +anyio==4.13.0 +babel==2.18.0 +certifi==2026.5.20 +charset-normalizer==3.4.7 +click==8.4.0 +colorama==0.4.6 +docutils==0.22.4 +h11==0.16.0 +idna==3.15 +imagesize==2.0.0 +Jinja2==3.1.6 +MarkupSafe==3.0.3 +packaging==26.2 +Pygments==2.20.0 +requests==2.34.2 +roman-numerals==4.1.0 +snowballstemmer==3.0.1 +Sphinx==9.1.0 +sphinx-autobuild==2025.8.25 +sphinx_rtd_theme==3.1.0 +sphinxcontrib-applehelp==2.0.0 +sphinxcontrib-devhelp==2.0.0 +sphinxcontrib-htmlhelp==2.1.0 +sphinxcontrib-jquery==4.1 +sphinxcontrib-jsmath==1.0.1 +sphinxcontrib-qthelp==2.0.0 +sphinxcontrib-serializinghtml==2.0.0 +starlette==1.0.0 +urllib3==2.7.0 +uvicorn==0.47.0 +watchfiles==1.2.0 +websockets==16.0 diff --git a/source/_images/audience.png b/source/_images/audience.png new file mode 100644 index 0000000..ae9e4e5 Binary files /dev/null and b/source/_images/audience.png differ diff --git a/source/_images/china_flag.png b/source/_images/china_flag.png new file mode 100644 index 0000000..4d983e4 Binary files /dev/null and b/source/_images/china_flag.png differ diff --git a/source/_images/desktop.png b/source/_images/desktop.png new file mode 100644 index 0000000..2e105f1 Binary files /dev/null and b/source/_images/desktop.png differ diff --git a/source/_images/iphonex.png b/source/_images/iphonex.png new file mode 100644 index 0000000..6857f5a Binary files /dev/null and b/source/_images/iphonex.png differ diff --git a/source/_images/objectives.png b/source/_images/objectives.png new file mode 100644 index 0000000..0fe5051 Binary files /dev/null and b/source/_images/objectives.png differ diff --git a/source/_images/prerequisites.png b/source/_images/prerequisites.png new file mode 100644 index 0000000..52832d8 Binary files /dev/null and b/source/_images/prerequisites.png differ diff --git a/source/conf.py b/source/conf.py new file mode 100644 index 0000000..ff53505 --- /dev/null +++ b/source/conf.py @@ -0,0 +1,47 @@ +# Configuration file for the Sphinx documentation builder. +# +# For the full list of built-in configuration values, see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Project information ----------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information + +project = 'Sphinx Demo' +copyright = '2026, Xarkam' +author = 'Xarkam' +release = '0.0.1' + +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration + +extensions = ['sphinx.ext.autodoc','sphinx_rtd_theme'] + +templates_path = ['_templates'] +exclude_patterns = [] + + + +# -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output + +html_theme = 'sphinx_rtd_theme' +html_static_path = ['_static'] + +html_theme_options = { + 'analytics_id': 'G-XXXXXXXXXX', # Provided by Google in your dashboard + 'analytics_anonymize_ip': False, + 'logo_only': False, + 'prev_next_buttons_location': 'bottom', + 'style_external_links': False, + 'vcs_pageview_mode': '', + # 'style_nav_header_background': 'white', + 'flyout_display': 'hidden', + 'version_selector': True, + 'language_selector': True, + # Toc options + 'collapse_navigation': True, + 'sticky_navigation': True, + 'navigation_depth': 4, + 'includehidden': True, + 'titles_only': False +} \ No newline at end of file diff --git a/source/index.rst b/source/index.rst new file mode 100644 index 0000000..bb24ce8 --- /dev/null +++ b/source/index.rst @@ -0,0 +1,151 @@ +.. Comments section. + Please, add custom directive or links, pictures, text replacement at the end of this document + + +======================= +Jam.py V7 documentation +======================= + +Introduction +============== + + +Welcome to Jam.py! If you are new to Jam.py or no-code, low-code or more-code Web application development, this is the place to find documentation about the Jam.py V7. + +The biggest difference to Jam.py V5 is : + - :doc:`routing ` support + - Bootstrap 5 + - modern support for mobile devices (see :doc:`version 7 `). + +In addition, the complete interface for |desktop_ico| :doc:`Desktop ` or |mobile_phone_ico| :doc:`Mobile ` devices is driven by a no-code approach. +Just select what is needed for any device and off you go. + +|objectives_ico| **Objectives** + + Installing Python [1]_ and Jam.py, choosing the database and the Web server and making Application Design decisions. + +|audience_ico| **Audience** + + Web development enthusiasts or developers, with a limited or no experience with the Web development, or deployment. + +|prerequisites_ico| **Prerequisites** + + The general knowledge about the Command Line prompt, and typing the commands is required and for advanced usages some Python and JavaScript knowledge is recommended. + + +Feed the LLM +============== + +The LLMS-full.txt is released: + +- https://jampy-docs-v7.readthedocs.io/en/latest/llms-full.txt +- https://jampy-docs-v7.readthedocs.io/en/latest/llms.txt + + +The Github Jam.py repository: https://github.com/jam-py-v5/jam-py-v7 + + + +Documentation Layout Overview +================================== + +Here is an overview of the documentation layout, to +help you find out where to look for specific details: + +:doc:`Getting started ` topics describe how to install the framework, create +a new project, develop a web application step-by-step, and deploy it. + +:doc:`Programming guides` +discuss key topics and concepts at a fairly high level and provide useful +background information and explanation. + +:doc:`Business application builder ` is a detailed description of +the Application Builder used for application development and database +administration. + +:doc:`Class reference guides ` contain technical reference for +Jam.py classes APIs. + +:doc:`FAQ ` topics covers most frequently asked questions. + +:doc:`How to ` contains code examples that can be useful to quickly +accomplish common tasks. + +Please visit the +:doc:`table of contents ` or even + +`Jam.py Application Design Tips`_, for detailed steps how to build the applications or migrate from MS Access. + +.. _`Jam.py Application Design Tips`: https://jampy-application-design-tips.readthedocs.io/ + +Documentation Download +====================== + +To download this document as a single PDF, please visit https://jampy-docs-v7.readthedocs.io/_/downloads/en/latest/pdf/ + +Documentation Translations +=========================== + +|china_flag_ico| Simplified Chinese translation started at https://jampy-docs.readthedocs.io/projects/V7/zh-cn/latest + +Video Tutorials +=============== + +| If you are new to Jam.py, we highly recommend that you watch these video tutorials. +| The videos are referring to Jam.py V5. There are minimal changes to the User interface compared to V7. + +It is recommended to watch these videos with a resolution of 1080p. + + +- Tutorial 1 - `Working with files and images `__ + +- Tutorial 2 - `Working with details `__ + +- Tutorial 3 - `Users, roles, audit trail/change history `__ + +- Tutorial 4 - `Task tree `__ + +- Tutorial 5 - `Forms `__ + +- Tutorial 6 - `Form events `__ + +- Tutorial 7 - `Data aware controls `__ + +- Tutorial 8 - `Datasets `__ + +- Tutorial 9 - `Datasets Part 2 `__ + +- Tutorial 10 - `Fields and filters `__ + +- Tutorial 11 - `Client-server interactions `__ + +- Tutorial 12 - `Working with data on the server `__ + + +.. [1] Only if you have no Python installer or unsupported Python version. + + + +.. |audience_ico| image:: ./_images/audience.png + :height: 4ex + :class: no-scaled-link + +.. |objectives_ico| image:: ./_images/objectives.png + :height: 4ex + :class: no-scaled-link + +.. |prerequisites_ico| image:: ./_images/prerequisites.png + :height: 4ex + :class: no-scaled-link + +.. |desktop_ico| image:: ./_images/desktop.png + :height: 2ex + :class: no-scaled-link + +.. |mobile_phone_ico| image:: ./_images/iphonex.png + :height: 2ex + :class: no-scaled-link + +.. |china_flag_ico| image:: ./_images/china_flag.png + :height: 3ex + :class: no-scaled-link \ No newline at end of file