Remove docs from minimum profile

abelsiqueira commented 2 months ago

Checklist before requesting a review

[x] I have read the contribution guidelines
[x] My code follows the style guidelines of this project
[x] I have performed a self-review of my code
[x] I have commented my code, particularly in hard-to-understand areas
[x] I have made corresponding changes to the documentation
[x] My changes generate no new warnings
[x] I have added tests that prove my fix is effective or that my feature works
[x] New and existing unit tests pass locally with my changes
[x] All user facing changes have been added to CHANGELOG.md

Type of change

[x] Breaking change (fix or feature that would cause existing functionality to not work as expected)

List of related issues or pull requests**

Refs:

593

Describe the changes made in this pull request

Introduces a question AddLocalDocumentation to control the existence of the docs folder.

If the user selects "Online documentation", then "Local documentation" is implied. The logic behind this approach is simply to define the computed variable AddLocalDocumentation based on either flag. The downside is that the generated answers will still only show the online flag.

Instructions to review the pull request

Possible things to check:

If strategy=minimal, then docs are not present
If strategy=recommended, then docs are present
If strategy=ask and only Online documentation is selected, the docs are present

Install the requirements

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

Create a new package using the template

copier copy --vcs-ref <YOUR_BRANCH> https://github.com/nlesc/python-template test_package

# Create a local environment to test your generated package locally
python -m venv env
source env/bin/activate
python -m pip install --upgrade pip setuptools
python -m pip install '.[dev,docs]'

Then run sphinx

sphinx-build -b html docs docs/_build/html

abelsiqueira commented 2 months ago

I just realised that there are some interactions with AddGitHubActionDocumentation_flag. What do you think is best, @fdiblen?

abelsiqueira commented 2 months ago

The interaction being that the action will try to build inexistent docs if we select one and not the other.

fdiblen commented 2 months ago

The interaction being that the action will try to build inexistent docs if we select one and not the other.

I think we can move Documentation option in SelectGitHubActions menu:

https://github.com/NLeSC/python-template/blob/c30e9a45f3d1587072034bd0c446516a77609819/copier/questions/features_code_quality.yml#L50-L51

to the documentation menu:

https://github.com/NLeSC/python-template/blob/c30e9a45f3d1587072034bd0c446516a77609819/copier/questions/features_documentation.yml#L26-L27

abelsiqueira commented 2 months ago

I've added a commit with that change.

abelsiqueira commented 2 months ago

Merging bypassing requirements. Thanks for the review

NLeSC / python-template