search

kedro-org / kedro

Kedro is a toolbox for production-ready data science. It uses software engineering best practices to help you create data engineering and data science pipelines that are reproducible, maintainable, and modular.
https://kedro.org
Apache License 2.0
9.88k stars 894 forks source link

Replace source code with GitHub links #4174

Open astrojuanlu opened 2 weeks ago

astrojuanlu commented 2 weeks ago

Description

Our docs contain a copy of all the source code of Kedro, see

https://docs.kedro.org/en/stable/_modules/

Instead, we should have links to our GitHub.

The reason is that we're using the viewcode extension:

https://github.com/kedro-org/kedro/blob/6bf29f9a7f9496ebffaa6f50e5d61549d21d8e0f/docs/source/conf.py#L50

We can replace it with the linkcode extension https://www.sphinx-doc.org/en/master/usage/extensions/linkcode.html

kbharat1210 commented 2 weeks ago

I would like to work on this.

astrojuanlu commented 1 week ago

Go ahead @kbharat1210!

kbharat1210 commented 1 week ago

I was not able to find the page to which you provided the link while navigating through the docs. Can you specify under which section/subsection i'll be able to find it in the docs.