Skip to content

[ENH] Link API Reference to source #565

@genedan

Description

@genedan

It's possible to link the API reference in the docs to the source code on Github. For example, in pandas and other pydata projects, there is a link to the source near the header:

Image

I've found out how to do this, the main thing you need is a function within the docs conf.py file:

https://github.com/genedan/TmVal/blob/69166dc91129b1a1760bfae2a73faa56ccd7aedc/docs/conf.py#L51-L102

Metadata

Metadata

Assignees

No one assigned

    Labels

    Documentation 📚Changes to docstrings or the documentation site. No codebase changes.Effort > Moderate 🐕Mid-sized tasks estimated to take a few days to a few weeks.Great First Contribution! 🌱Beginner friendly tickets with narrow scope and huge impact. Perfect to join our community!Impact > Moderate 🔶User-visible but non-breaking change. Treated like a minor version bump (e.g., 0.6.5 → 0.7.0).

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions