Skip to content

456-make online documentation optional #476

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.

Sign up for GitHub

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

Merged
fdiblen merged 11 commits into from
Aug 21, 2024
Merged

456-make online documentation optional #476

Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
37ce238
add online documentation question
fdiblen Aug 20, 2024
97cbfeb
update the changelog
fdiblen Aug 20, 2024
0856360
create the online documentation configration conditionally
fdiblen Aug 20, 2024
894a856
add next steps workflow for online documentation
fdiblen Aug 20, 2024
41e1fc1
add missing single quote to documentation workflow
fdiblen Aug 21, 2024
2400f30
create 03_readthedocs.md conditionally
fdiblen Aug 21, 2024
6934f22
remove read the docs from next_steps.yml
fdiblen Aug 21, 2024
92db4bd
create read the docs badge conditionally
fdiblen Aug 21, 2024
0b80ef5
mention read the docs configuration conditionally in project_setup.md
fdiblen Aug 21, 2024
7e2ea47
No newline when online docs == no
sverhoeven Aug 21, 2024
c25eea6
When nodoc then do not insert empty lines
sverhoeven Aug 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
No newline when online docs == no
  • Loading branch information
@sverhoeven
sverhoeven committed Aug 21, 2024
commit 7e2ea4739a646280f04e779fea7fd263aa3af4f0
4 changes: 3 additions & 1 deletion template/README.md.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,9 @@
| **Other best practices** |   |
| Static analysis | [![workflow scq badge](https://sonarcloud.io/api/project_badges/measure?project={{github_organization}}_{{package_name}}&metric=alert_status)](https://sonarcloud.io/dashboard?id={{github_organization}}_{{package_name}}) |
| Coverage | [![workflow scc badge](https://sonarcloud.io/api/project_badges/measure?project={{github_organization}}_{{package_name}}&metric=coverage)](https://sonarcloud.io/dashboard?id={{github_organization}}_{{package_name}}) |
{% if AddOnlineDocumentation %}| Documentation | [![Documentation Status](https://readthedocs.org/projects/{{package_name}}/badge/?version=latest)](https://{{package_name}}.readthedocs.io/en/latest/?badge=latest) |{% endif %}
{% if AddOnlineDocumentation -%}
| Documentation | [![Documentation Status](https://readthedocs.org/projects/{{package_name}}/badge/?version=latest)](https://{{package_name}}.readthedocs.io/en/latest/?badge=latest) |
{%- endif -%}
| **GitHub Actions** |   |
| Build | [![build]({{repository_url}}/actions/workflows/build.yml/badge.svg)]({{repository_url}}/actions/workflows/build.yml) |
| Citation data consistency | [![cffconvert]({{repository_url}}/actions/workflows/cffconvert.yml/badge.svg)]({{repository_url}}/actions/workflows/cffconvert.yml) |
Expand Down