456-make online documentation optional

[fdiblen]

Description

• I have read the contribution guidelines
• This update is in line with what is recommended in the Python chapter of the Guide
• All user facing changes have been added to CHANGELOG.md

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

Related issues:

• Add optional question to copier questionnaire: online documentation #456

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

[sjvrijn]

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

[sjvrijn]

Missing ' at the end of the line

[fdiblen]

fixed

[sverhoeven]

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.

[sverhoeven]

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

[fdiblen]

already done

[sverhoeven]

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

[sverhoeven]

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

[sverhoeven]

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

[fdiblen]

Thank you for reviewing, @sverhoeven and @sjvrijn!