Link back to github from reference API docs

Open Beginner friendly
#572 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
72/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Active
Tech stack
python
Domain
documentation

Research direction

Start at the referenced Sphinx API page for StrictIndexTypePandasDataFrameResult.build_result and inspect how the reference documentation is generated with autodoc. Determine where the documentation configuration or template controls links back to GitHub. Done means the rendered API reference includes a working link to the source code.

Written by the indexing model from the issue text.

Description

documentation good first issue

Is your feature request related to a problem? Please describe.
This should have a link to the code: https://hamilton.dagworks.io/en/latest/reference/result-builders/Pandas/#hamilton.base.StrictIndexTypePandasDataFrameResult.build_result

Describe the solution you'd like
Link somewhere, use whatever sphinx autodoc provides

Dominant language
Jupyter Notebook
Stars
2.6k
Forks
214
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from apache/hamilton

All issues in apache/hamilton

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.