Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace source code with GitHub links #4174

Closed
astrojuanlu opened this issue Sep 18, 2024 · 7 comments · Fixed by #4410
Closed

Replace source code with GitHub links #4174

astrojuanlu opened this issue Sep 18, 2024 · 7 comments · Fixed by #4410
Assignees
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation

Comments

@astrojuanlu
Copy link
Member

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:

"sphinx.ext.viewcode",

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

@astrojuanlu astrojuanlu added the Component: Documentation 📄 Issue/PR for markdown and API documentation label Sep 18, 2024
@kbharat1210
Copy link

I would like to work on this.

@astrojuanlu
Copy link
Member Author

Go ahead @kbharat1210!

@kbharat1210
Copy link

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.

@Nalito
Copy link

Nalito commented Oct 23, 2024

Hi @kbharat1210

I'd love to work on this issue.

@astrojuanlu astrojuanlu added the Hacktoberfest Issue suitable for hacktoberfest label Oct 23, 2024
@astrojuanlu
Copy link
Member Author

Hi @Nalito , go ahead!

@Nalito
Copy link

Nalito commented Oct 25, 2024

Hi @astrojuanlu

I can't find the code file for this page (https://docs.kedro.org/en/stable/_modules/). Can you help me with the link?

@ankatiyar
Copy link
Contributor

Done on Kedro #4410 and on kedro-datasets kedro-org/kedro-plugins#985
Kedro-viz doesn't have API docs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component: Documentation 📄 Issue/PR for markdown and API documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants