Skip to content

pisa.core.container module documentation#935

Merged
thehrh merged 1 commit into
masterfrom
enhancement/container_docs
May 15, 2026
Merged

pisa.core.container module documentation#935
thehrh merged 1 commit into
masterfrom
enhancement/container_docs

Conversation

@thehrh
Copy link
Copy Markdown
Collaborator

@thehrh thehrh commented May 11, 2026

The "bird's-eye view" of the various classes in the module and their functionalities will hopefully benefit anyone interested in understanding this central piece of code and contributing to it. This is why there is also a lot of focus on the formatting of these docs here, which make extensive use of sphinx directives and reST structure elements (compiled and tested locally to ensure they come out as intended)—more than what I'd usually consider worthwile.

There is also a new link/redirect from the "Contributing" section in the docs. Furthermore, the intersphinx-registry package is installed (similar to #916).

Fixes #816

@thehrh thehrh added this to the 4.3 milestone May 11, 2026
@thehrh thehrh requested a review from JanWeldert May 11, 2026 16:54
@thehrh thehrh merged commit 1b3134f into master May 15, 2026
2 checks passed
@thehrh thehrh deleted the enhancement/container_docs branch May 18, 2026 10:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

pisa.core.container module is too sparsely documented ...

2 participants