Add sphinx-argparse documentation #457
Conversation
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
Co-authored-by: Mahe Iram Khan <65779580+ForgottenProgramme@users.noreply.github.com>
|
is that ready for review? |
Yes, this PR is ready for review. If it is merged, follow this documentation to allow the workflow to publish pages. https://docs.github.com/en/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site#publishing-with-a-custom-github-actions-workflow |
|
Sorry for my delay |
|
@marcelotrevisani it looks like you need to set up github actions as a source for github pages, and then re-run the sphinx workflow. You can find me on the conda-forge chat if that would help. |
|
It works! |
|
Is there a link to the docs? I can't seem to find where they are deployed. |
|
@BastianZim https://conda.github.io/grayskull/ @marcelotrevisani there was an issue with the GitHub pages setting of the repo, it was still set up to deploy from the |
|
Oh nice -- thanks! Might be good to link that in the readme? |
Description
This includes sphinx-argparse documentation for grayskull's cli. The cli was moved into a file not called
__main__and rearranged a bit to make it clear we can import the parser without running the tool. A workflow should automatically publish these to github pages if the project is set up to accept pages from a workflow, instead of a special branch.It would be nice to include README.md in the documentation, like https://github.com/conda/conda-package-streaming/blob/main/docs/index.md?plain=1#L26 ; had some trouble with sphinx errors when doing so.