Skip to content

Add source code to documentation #10676

Closed
@timhoffm

Description

@timhoffm

Feature Request

I propose to use the Sphinx extension sphinx.ext.viewcode to add the python source code to the docs and crosslink it.

This could help users understand the relations between the various levels of indirection we use. Also it could be a little help with poorly or undocumented parts of the API (we should improve the docs, but that's a long-term project).

Here is an example how this would look like (note the [source] link):

grafik

The link will guide to a page containing the source code:

grafik

Please give a short feedback on the idea. If there is a general approval, I'll submit a pull request.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions