Add more metadata to cookiecutter
This commit is contained in:
parent
a0c543bfad
commit
1a73c9e3ad
7 changed files with 47 additions and 8 deletions
|
@ -1,11 +1,16 @@
|
|||
{
|
||||
"output_directory": "",
|
||||
|
||||
"modid": "",
|
||||
"mod_name": "{{ cookiecutter.modid|capitalize }}",
|
||||
"mod_display_name": "{{ cookiecutter.modid|capitalize }}",
|
||||
"plugin_classname": "{{ cookiecutter.modid|capitalize }}Plugin",
|
||||
|
||||
"github_repo": "{{ cookiecutter.modid|capitalize }}",
|
||||
"main_branch": "main",
|
||||
"author": "",
|
||||
"fallback_book_url": "https://example.com",
|
||||
"author": "TODO",
|
||||
|
||||
"fallback_book_url": "https://{{ cookiecutter.author|lower }}.github.io/{{ cookiecutter.github_repo }}/",
|
||||
|
||||
"pattern_regex": [
|
||||
"hex_latest",
|
||||
"hex_0.10.3",
|
||||
|
|
29
doc/{{cookiecutter.output_directory}}/.gitignore
vendored
29
doc/{{cookiecutter.output_directory}}/.gitignore
vendored
|
@ -1,3 +1,32 @@
|
|||
# eclipse
|
||||
bin
|
||||
*.launch
|
||||
.settings
|
||||
.metadata
|
||||
.classpath
|
||||
.project
|
||||
|
||||
# idea
|
||||
out
|
||||
*.ipr
|
||||
*.iws
|
||||
*.iml
|
||||
.idea
|
||||
|
||||
# gradle
|
||||
build
|
||||
.gradle
|
||||
|
||||
# other
|
||||
eclipse
|
||||
run
|
||||
|
||||
# Files from Forge MDK
|
||||
forge*changelog.txt
|
||||
|
||||
Session.vim
|
||||
plot/
|
||||
|
||||
# hexdoc
|
||||
doc/**/_export/generated/
|
||||
_site/
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
# {{ cookiecutter.__project_name }}
|
||||
|
||||
This is the Python docgen for {{ cookiecutter.mod_name }}.
|
||||
Python web book docgen and [hexdoc](https://pypi.org/project/hexdoc) plugin for {{ cookiecutter.mod_display_name }}.
|
||||
|
||||
## Version scheme
|
||||
|
||||
|
|
|
@ -48,7 +48,7 @@ packages = [
|
|||
]
|
||||
|
||||
[template.args]
|
||||
mod_name = "{{ cookiecutter.mod_name }}"
|
||||
mod_name = "{{ cookiecutter.mod_display_name }}"
|
||||
author = "{{ cookiecutter.author }}"
|
||||
icon_href = "icon.png"
|
||||
show_landing_text = false
|
||||
|
|
|
@ -1,8 +1,8 @@
|
|||
{
|
||||
hexdoc: {
|
||||
"{{ cookiecutter.modid }}": {
|
||||
title: "{{ cookiecutter.mod_name }} Book",
|
||||
description: "The {{ cookiecutter.mod_name }} Book, all in one place.",
|
||||
title: "{{ cookiecutter.mod_display_name }} Book",
|
||||
description: "The {{ cookiecutter.mod_display_name }} Book, all in one place.",
|
||||
},
|
||||
}
|
||||
}
|
|
@ -6,6 +6,7 @@ build-backend = "hatchling.build"
|
|||
|
||||
[project]
|
||||
name = "{{ cookiecutter.__project_name }}"
|
||||
description = "Python web book docgen and hexdoc plugin for {{ cookiecutter.mod_display_name }}."
|
||||
readme = "doc/README.md"
|
||||
authors = [
|
||||
{ name="{{ cookiecutter.author }}" },
|
||||
|
@ -14,6 +15,10 @@ keywords = ["hexdoc"]
|
|||
requires-python = ">=3.11"
|
||||
dynamic = ["version", "dependencies", "optional-dependencies"]
|
||||
|
||||
[project.urls]
|
||||
Homepage = "{{ cookiecutter.fallback_book_url }}"
|
||||
Source = "https://github.com/{{ cookiecutter.author }}/{{ cookiecutter.github_repo }}/tree/{{ cookiecutter.main_branch }}/doc"
|
||||
|
||||
# Gradle version/deps
|
||||
|
||||
[tool.hatch.version]
|
||||
|
|
|
@ -15,7 +15,6 @@ readme = "doc/README.md"
|
|||
license = { file = "doc/LICENSE.txt" }
|
||||
keywords = ["hexdoc"]
|
||||
classifiers = [
|
||||
"Framework :: Hatch",
|
||||
"Intended Audience :: Developers",
|
||||
"License :: OSI Approved :: MIT License",
|
||||
"Operating System :: OS Independent",
|
||||
|
@ -55,6 +54,7 @@ dev = [
|
|||
]
|
||||
|
||||
[project.urls]
|
||||
Homepage = "https://object-object.github.io/HexMod/" # TODO: replace
|
||||
Source = "https://github.com/object-Object/HexMod/tree/docgen-2-1.20/doc" # TODO: replace
|
||||
|
||||
# Gradle version/deps
|
||||
|
|
Loading…
Reference in a new issue