Use a proper table for module TOC #162
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Now groups classes by logical group, eg:
|
nyalldawson
commented
Aug 16, 2024
3nids
reviewed
Aug 16, 2024
scripts/make_api_rst.py
Outdated
| @@ -78,6 +79,73 @@ def ltr_tag(v): | |||
| r"""^(?:([\w.]+::)?([\w.]+\.)?(\w+)\s*(?:\((.*)\)(?:\s*->\s*([\w.]+(?:\[.*?\])?))?(?:\s*\[(signal)\])?)?)?$""" | |||
| ) | |||
|
|
|||
| group_names = { | |||
There was a problem hiding this comment.
to be coherent, I would move this to https://github.com/qgis/pyqgis-api-docs-builder/blob/main/pyqgis_conf.yml
And include the brief description of classes in the table
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
nyalldawson
force-pushed
the
class_toc_summary
branch
from
c850702 to
ca8d93c
Compare
3nids
approved these changes
Aug 18, 2024
|
@3nids what's involved in publishing a new version to the actual site? When's that triggered? |
|
Every push to main on this repo will publish a new version, otherwise it's at least once per week if there is no activity here. It used the Deb packages, so any change on QGIS source takes a couple of days to be reflected. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
And include the brief description of classes in the table.
Before:
After: