Skip to content

Commit dbf29ea

Browse files
authored
Merge pull request #48 from jcook3701/develop
Feat 016 (#47)
2 parents 3cb8cda + 510866b commit dbf29ea

File tree

7 files changed

+56
-28
lines changed

7 files changed

+56
-28
lines changed

changelogs/CHANGELOG.md

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -142,16 +142,29 @@ Feat 013 (#41)
142142
- Merge pull request #44 from jcook3701/develop
143143

144144
Feat 014 (#43)
145+
- Feat 015 (#45)
145146

146-
### 🐛 Fixed
147+
* fix(links): More link fixes along with a few configuration fixes to remove warnings.
147148

148-
- *(template)* Updates to template cookiecutter.json file.
149-
- *(links)* More link fixes along with a few configuration fixes to remove warnings.
149+
* feat(links): More links and general docs template updates.
150+
151+
* feat(docs): Documentation updates.
152+
153+
* chore(upgrade): Update template from cookiecutter-cookiecutter.
154+
- Merge pull request #46 from jcook3701/develop
150155

151-
### 🚀 Added
156+
Feat 015 (#45)
152157

153-
- *(links)* More links and general docs template updates.
154-
- *(docs)* Documentation updates.
158+
### 🐛 Fixed
159+
160+
- *(template)* Updates to template cookiecutter.json file.
161+
- *(docs)* Docs are not being updated with upgrade for some reason. debugging.
162+
- *(docs)* Revert. Docs are not being updated with upgrade for some reason. debugging.
163+
- *(template)* Figured out _is_sub_template needs to be false for the documents. Need to fix the cookiecutter-cookiecutter hooks.
164+
- *(configuration)* Cookiecutter upgrader configuration fix.
165+
- *(template)* Forgot to add configuration setting to main settings file.
166+
- *(template)* Forgot to add configuration setting to main settings file.
167+
- *(theme)* Update to latest just the docs theme.
155168
## [0.1.0] - 2025-12-05
156169

157170
### ⚙️ Miscellaneous

changelogs/releases/v0.1.1.md

Lines changed: 19 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -142,13 +142,26 @@ Feat 013 (#41)
142142
- Merge pull request #44 from jcook3701/develop
143143

144144
Feat 014 (#43)
145+
- Feat 015 (#45)
145146

146-
### 🐛 Fixed
147+
* fix(links): More link fixes along with a few configuration fixes to remove warnings.
147148

148-
- *(template)* Updates to template cookiecutter.json file.
149-
- *(links)* More link fixes along with a few configuration fixes to remove warnings.
149+
* feat(links): More links and general docs template updates.
150+
151+
* feat(docs): Documentation updates.
152+
153+
* chore(upgrade): Update template from cookiecutter-cookiecutter.
154+
- Merge pull request #46 from jcook3701/develop
150155

151-
### 🚀 Added
156+
Feat 015 (#45)
152157

153-
- *(links)* More links and general docs template updates.
154-
- *(docs)* Documentation updates.
158+
### 🐛 Fixed
159+
160+
- *(template)* Updates to template cookiecutter.json file.
161+
- *(docs)* Docs are not being updated with upgrade for some reason. debugging.
162+
- *(docs)* Revert. Docs are not being updated with upgrade for some reason. debugging.
163+
- *(template)* Figured out _is_sub_template needs to be false for the documents. Need to fix the cookiecutter-cookiecutter hooks.
164+
- *(configuration)* Cookiecutter upgrader configuration fix.
165+
- *(template)* Forgot to add configuration setting to main settings file.
166+
- *(template)* Forgot to add configuration setting to main settings file.
167+
- *(theme)* Update to latest just the docs theme.

cookiecutter.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@
5050
"ros2",
5151
"typescript"
5252
],
53+
"_default_branch": "master",
5354
"_is_sub_template": true,
5455
"_copy_without_render": [
5556
"README.md",

docs/cookiecutter_input.json

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
"__year_range": "2025-2026",
1616
"_checkout": "main",
1717
"_copy_without_render": [],
18-
"_default_branch": "master",
18+
"_default_branch": "main",
1919
"_extensions": [
2020
"jinja2.ext.do",
2121
"jinja2.ext.loopcontrols"
@@ -26,10 +26,10 @@
2626
"changelog": false,
2727
"git-init": false,
2828
"pre-commit-init": false,
29-
"python-install": false
29+
"python-install": true
3030
}
3131
},
32-
"_is_sub_template": true,
32+
"_is_sub_template": false,
3333
"_jinja2_env_vars": {
3434
"lstrip_blocks": true,
3535
"trim_blocks": true
@@ -59,7 +59,7 @@
5959
"python_version": "3.11",
6060
"repo_url": "https://github.com/jcook3701/github-docs-cookiecutter",
6161
"template_type": "cookiecutter",
62-
"theme": "pmarsceill/just-the-docs",
62+
"theme": "just-the-docs/just-the-docs@v0.11.0",
6363
"timezone": "America/Los_Angeles",
6464
"twitter_username": "",
6565
"version": "0.1.1"

docs/jekyll/docs/cookiecutter_input.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
{
22
"__year_range": "2025-2026",
3-
"_checkout": null,
3+
"_checkout": "master",
44
"_copy_without_render": [
55
"README.md",
66
"_includes/*"
77
],
8+
"_default_branch": "master",
89
"_extensions": [
910
"jinja2.ext.do",
1011
"jinja2.ext.loopcontrols",
@@ -36,7 +37,7 @@
3637
"publication_year": "2025",
3738
"repo_url": "https://github.com/jcook3701/github-docs-cookiecutter",
3839
"template_type": "cookiecutter",
39-
"theme": "pmarsceill/just-the-docs",
40+
"theme": "just-the-docs/just-the-docs@v0.11.0",
4041
"timezone": "America/Los_Angeles",
4142
"twitter_username": "",
4243
"version": "0.1.1"

{{ cookiecutter.project_slug }}/_config.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ remote_theme: "{{ cookiecutter.theme }}"
99
ga_tracking: "{{ cookiecutter.ga_tracking }}"
1010

1111
repo_url: "{{ cookiecutter.repo_url }}"
12-
repo_blob: "{{cookiecutter.repo_url }}/blob/{{ cookiecutter._checkout }}"
12+
repo_blob: "{{ cookiecutter.repo_url }}/blob/{{ cookiecutter._default_branch }}"
1313
github_io_url: "{{ cookiecutter.github_io }}"
1414
repository: "{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}"
1515

@@ -102,7 +102,7 @@ back_to_top_text: "Back to top"
102102

103103
footer_content: >-
104104
{{ cookiecutter.copyright }}. Distributed by an
105-
<a href="{{ cookiecutter.repo_url }}/blob/master/LICENSE.md">
105+
<a href="{{ cookiecutter.repo_url }}/blob/{{ cookiecutter._default_branch }}/LICENSE.md">
106106
{{ cookiecutter.license }} license.
107107
</a>
108108
<a href=""></a>
@@ -121,7 +121,7 @@ gh_edit_link_text: "Edit this page on GitHub"
121121
gh_edit_repository: >-
122122
{{ cookiecutter.repo_url }}
123123
# the branch that your docs is served from
124-
gh_edit_branch: "master"
124+
gh_edit_branch: "{{ cookiecutter._default_branch }}"
125125
# the source that your files originate from
126126
gh_edit_source: docs
127127
# "tree" or "edit" if you want the user to jump into the editor immediately

{{ cookiecutter.project_slug }}/_manual/contribute/index.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@ We're excited that you're considering making a contribution to the {{ cookiecutt
1010

1111
These are some good resources to explore for developers:
1212

13-
* [Create a pull request]({% raw %}{% link _manual/contribute/create-pull-request.md %}{% endraw %})
14-
* [Create a feature request]({% raw %}{% link _manual/contribute/create-feature-request.md %}{% endraw %})
15-
* [Developer guide]({% raw %}{% link _manual/contribute/developer-guide.md %}{% endraw %})
16-
* [Merge a pull request]({% raw %}{% link _manual/contribute/merge-pull-request.md %}{% endraw %})
13+
* [Create a pull request]({% raw %}{% link _manual/contribute/create-pull-request.md %}{% endraw %})
14+
* [Create a feature request]({% raw %}{% link _manual/contribute/create-feature-request.md %}{% endraw %})
15+
* [Developer guide]({% raw %}{% link _manual/contribute/developer-guide.md %}{% endraw %})
16+
* [Merge a pull request]({% raw %}{% link _manual/contribute/merge-pull-request.md %}{% endraw %})
1717

1818
Find [style guides]({% raw %}{% link _manual/contribute/style-guides/index.md %}{% endraw %}) for the {{ cookiecutter.project_name }} software project:
19-
* [Python]({% raw %}{% link _manual/contribute/style-guides/python.md %}{% endraw %}) style guide.
20-
* [Typescript]({% raw %}{% link _manual/contribute/style-guides/typescript.md %}{% endraw %}) style guide.
21-
* [YAML]({% raw %}{% link _manual/contribute/style-guides/yaml.md %}{% endraw %}) style guide.
19+
* [Python]({% raw %}{% link _manual/contribute/style-guides/python.md %}{% endraw %}) style guide.
20+
* [Typescript]({% raw %}{% link _manual/contribute/style-guides/typescript.md %}{% endraw %}) style guide.
21+
* [YAML]({% raw %}{% link _manual/contribute/style-guides/yaml.md %}{% endraw %}) style guide.

0 commit comments

Comments
 (0)