Skip to content

Fix 189 #193

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
HannoSpreeuw merged 11 commits into from
Jan 20, 2026
Merged

Fix 189 #193

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
06cfafa
Attribute descriptions of conf classes to dicts
HannoSpreeuw Jan 15, 2026
0c0a75f
Command-line descriptions come from dicts
HannoSpreeuw Jan 15, 2026
fde51d8
Render "IMGCONF_HELP" and "EXPORTSETTINGS_HELP"
HannoSpreeuw Jan 15, 2026
195b463
"type" and "value" are not applied in "excepthook"
HannoSpreeuw Jan 15, 2026
76d9f9f
"args" is not used by "handle_args"
HannoSpreeuw Jan 15, 2026
9e1987c
Make clear what the status of config.toml is
HannoSpreeuw Jan 15, 2026
92a9222
Removing "type" and "value" led to "mypy" error
HannoSpreeuw Jan 15, 2026
257c6d2
GH CI seems to be agnostic of "docs" folder.
HannoSpreeuw Jan 15, 2026
afb496a
Move tests to test suite
HannoSpreeuw Jan 20, 2026
542848c
No support for "Enum" classes needed here.
HannoSpreeuw Jan 20, 2026
a6d3a4e
This should also work for Python 3.10 and 3.11
HannoSpreeuw Jan 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/source/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
"autoapi.extension",
"enum_tools.autoenum",
"sphinxarg.ext",
"sourcefinder.sphinx_ext.render_confs",
]

autodoc_typehints = "both"
Expand Down
6 changes: 6 additions & 0 deletions docs/source/config.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Descriptions of configuration parameters
========================================

The following parameters control PySE's source extraction and export settings.

.. render_confs::
1 change: 1 addition & 0 deletions docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Welcome to PySE's documentation!
README
sourceparams
cli
config


Indices and tables
Expand Down
Loading