FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

456-make online documentation optional by fdiblen · Pull Request #476 · NLeSC/python-template · GitHub

456-make online documentation optional - #476

Merged
fdiblen merged 11 commits into
mainfrom
456_online_documentation
Aug 21, 2024
Merged

456-make online documentation optional#476
fdiblen merged 11 commits into
mainfrom
456_online_documentation

Conversation

fdiblen commented Aug 20, 2024
edited
Loading

Copy link
Copy Markdown
Member

Description

This PR makes online documentation (Read the Docs) optional.

Related issues:

Instructions to review the pull request

Install the requirements

cd $(mktemp -d --tmpdir py-tmpl-XXXXXX)
pip install pipx
pipx install copier

Test 1:
Run the command below and say 'yes' to citation question

copier copy --vcs-ref 456_online_documentation https://github.com/nlesc/python-template test_yes

Test 2:
Run the command below and say 'no' to citation question

copier copy --vcs-ref 456_online_documentation https://github.com/nlesc/python-template test_no

You should see the files below only when you say 'yes':

  • .github/workflows/next_steps_online_documentation.yml
  • .readthedocs.yaml

Test 3:

  • Push the generated package to a GitHub repository
  • Check if next_steps_online_documentation.yml workflow runs
  • Check if a Github issue about Read the Docs is created

fdiblen marked this pull request as ready for review August 20, 2024 16:01

sjvrijn left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Looks good to me, except for the echo erroring in the action

id: readthedocs
- name: List created issues
run: |
echo 'Created issues that must be completed to have fully working Python package:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Missing ' at the end of the line

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

fixed

sverhoeven left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Would be nice to remove Create readthedocs issue step in .github/workflows/next_steps.yml workflow.

In README.md there is a badge for rtd that should be surrounded with if clause.

In project_setup.md there is mention of rtd that should be surrounded with if clause.

permissions:
contents: write
issues: write
name: Create issues for next steps

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Both next_steps*.yml workflows have same name. Please make unique

Suggested change
name: Create issues for next steps
name: Create readthedocs issue for next steps

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

already done

Copy link
Copy Markdown
Member

The 'Next step: Read the Docs' issue was created in my new repo.

Copy link
Copy Markdown
Member

On saying no the .github/next_steps/03_readthedocs.md should not be present.

fdiblen requested review from sjvrijn and sverhoeven August 21, 2024 09:24
fdiblen mentioned this pull request Aug 21, 2024
3 tasks

sverhoeven left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Looks ok. I added some - to not have empty newlines when you say no.

fdiblen commented Aug 21, 2024

Copy link
Copy Markdown
Member Author

Thank you for reviewing, @sverhoeven and @sjvrijn!

fdiblen merged commit 977268c into main Aug 21, 2024
fdiblen deleted the 456_online_documentation branch August 21, 2024 11:22
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants


Back | FazBrowse Home | New Git URL