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

Add complete steps for recipes in sphinx tabs #1755

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

shloka-gupta
Copy link
Contributor

PR Checklist:

  • make all edits to the docs in the src directory, not in docs or in the html files
  • note any issues closed by this PR with closing keywords
  • put any other relevant information below

Issue #1731

Additional information:

  • Creating a rough PR for feedback to know if this idea should be explored further.
  • Haven't added the steps for CRAN yet.
  • Added Grayskull info for pypi packages but not GitHub repositories. Shall I add that as well?
  • Will add the links towards the end.
  • Further work is to be done.

A sneak:

Screenshot (57)

@shloka-gupta
Copy link
Contributor Author

@kathatherine @beckermr @BastianZim would be really glad to hear your opinion!

Sorry for the delay, had a few tests to give.

@BastianZim
Copy link
Member

I like it, looks good.
It could be though that someone doesn't know what Grayskull is so the tab would either need to be changed to PyPI or Grayskull explained before that. That way a user knows why to select it.

Copy link
Contributor

@kathatherine kathatherine left a comment

Choose a reason for hiding this comment

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

Sorry for the delay on this

src/maintainer/adding_pkgs.rst Outdated Show resolved Hide resolved
src/maintainer/adding_pkgs.rst Show resolved Hide resolved
src/maintainer/adding_pkgs.rst Outdated Show resolved Hide resolved
src/maintainer/adding_pkgs.rst Outdated Show resolved Hide resolved
src/maintainer/adding_pkgs.rst Outdated Show resolved Hide resolved
src/maintainer/adding_pkgs.rst Outdated Show resolved Hide resolved
src/maintainer/adding_pkgs.rst Outdated Show resolved Hide resolved
src/maintainer/adding_pkgs.rst Outdated Show resolved Hide resolved
src/maintainer/adding_pkgs.rst Outdated Show resolved Hide resolved


Generate a python package recipe with Grayskull:
--------------------------------------------------
Copy link
Contributor

Choose a reason for hiding this comment

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

If you could make this header underline and the one in the other tabbed section the same length as the header, that would be great.

Copy link
Contributor

@kathatherine kathatherine left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks!

@jaimergp jaimergp added the Docs label Jul 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

Successfully merging this pull request may close these issues.

4 participants