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

Removing The Show_Source Button from API pages #48955

Closed
wants to merge 3 commits into from

Conversation

Pro-Coder04
Copy link

@Pro-Coder04 Pro-Coder04 commented Oct 5, 2022

Made the required changes in the conf.py file.
It removes the show_source button from the API pages.

@mroeschke mroeschke added the Web pandas website label Oct 5, 2022
@mroeschke mroeschke added this to the 1.5.1 milestone Oct 6, 2022
Copy link
Member

@mroeschke mroeschke left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM cc @datapythonista

@@ -388,7 +388,7 @@
# html_split_index = False

# If true, links to the reST sources are added to the pages.
# html_show_sourcelink = True
# html_show_sourcelink = False
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems to be a comment, did you try that this is working as expected?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Even I had a similar doubt.
But since someone in the comments had suggested it so I implemented it.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess you need to uncomment this line besides changing thr value.

But you should build the docs locally and check that whatever you changed works as expected.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have uncommented that line
Since the changes are reflected on the API pages I have no idea on how to check if it is working as expected.
If you could just guide me on that it will be very handy since I'm new to this open source contribution field

@datapythonista
Copy link
Member

You need to create a pandas development environment with mamba, then run the make.py script in docs, start an http server with python -m http.server inside the build directory, and then you navigate the docs in your local instance of the docs.

Full documentation on this and more is here: https://pandas.pydata.org/docs/development/index.html

@datapythonista datapythonista modified the milestones: 1.5.1, 1.5.2 Oct 17, 2022
Copy link
Member

@datapythonista datapythonista left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@Pro-Coder04 did you try if this is working as expected? Can you provide a screenshot so reviewers can see how the change looks like please? Thanks!

@datapythonista datapythonista removed this from the 1.5.2 milestone Nov 15, 2022
@github-actions
Copy link
Contributor

This pull request is stale because it has been open for thirty days with no activity. Please update and respond to this comment if you're still interested in working on this.

@github-actions github-actions bot added the Stale label Dec 16, 2022
@mroeschke
Copy link
Member

Thanks for the pull request, but it appears to have gone stale. If interested in continuing, please merge in the main branch, address any review comments and/or failing tests, and we can reopen.

@mroeschke mroeschke closed this Dec 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Stale Web pandas website
Projects
None yet
Development

Successfully merging this pull request may close these issues.

DOC: "Show Source" button on API pages does not link to expected source code
3 participants