Add docs for the cutter

.pre-commit-config.yaml

@@ -0,0 +1,9 @@
+repos:
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  # Ruff version.
+  rev: v0.1.4
+  hooks:
+    # Run the linter.
+    - id: ruff
+    # Run the formatter.
+    - id: ruff-format

hooks/post_gen_project.py

@@ -1,4 +1,4 @@
-# -*- coding: utf-8 -*-
+"""Post-generate hook to be run after project generation."""
 
 print(
     """
@@ -32,5 +32,10 @@
 
    https://aiidalab.readthedocs.io/en/latest/app_development/publish.html
 
+6. Import your repository to readthedocs.org to automatically build and publish your documentation, with the following instructions:
+
+    https://readthedocs.org/dashboard/import/ for the import of your repository.
+    https://docs.readthedocs.io/en/stable/pull-requests.html for the configuration of pull request previews.
+
 """
 )

ruff.toml

@@ -0,0 +1,19 @@
+target-version = "py39"
+
+[lint]
+extend-select = [
+  "UP",  # pyupgrade
+  "D",   # pydocstyle
+]
+
+ignore = [
+    "UP009",
+    "D205",
+    "D212",
+    "D415",
+    "D100",
+    "D103",
+]
+
+[lint.pydocstyle]
+convention = "google"

{{cookiecutter.repo_name}}/.pre-commit-config.yaml

@@ -1,12 +1,9 @@
 repos:
-  - repo: https://github.com/psf/black
-    rev: 20.8b1
-    hooks:
-      - id: black
-        language_version: python3 # Should be a command that runs python3.6+
-
-  - repo: https://gitlab.com/pycqa/flake8
-    rev: '3.8.4'
-    hooks:
-    - id: flake8
-      args: [--count, --show-source, --statistics]
+- repo: https://github.com/astral-sh/ruff-pre-commit
+  # Ruff version.
+  rev: v0.1.4
+  hooks:
+    # Run the linter.
+    - id: ruff
+    # Run the formatter.
+    - id: ruff-format

{{cookiecutter.repo_name}}/.readthedocs.yml

@@ -0,0 +1,19 @@
+# Read the Docs configuration file for MkDocs projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+mkdocs:
+  configuration: mkdocs.yml
+
+# Optionally declare the Python requirements required to build your docs
+python:
+  install:
+  - requirements: docs/requirements.txt

{{cookiecutter.repo_name}}/__init__.py

@@ -1,4 +1,5 @@
 # -*- coding: utf-8 -*-
+
 """
 {{cookiecutter.app_title}}
 {{cookiecutter.repo_name}}

{{cookiecutter.repo_name}}/docs/development.md

@@ -0,0 +1,3 @@
+# Development
+
+Here may go a few notes on how to contribute the development of the app.

{{cookiecutter.repo_name}}/docs/index.md

@@ -0,0 +1,16 @@
+# Introduction
+
+This is the documentation for the `{{cookiecutter.repo_name}}` app. 
+{{ cookiecutter.short_description }}
+
+## Quick start
+
+To access the app, you should open AiiDAlab platform first by either:
+
+- Log into one of the [open AiiDAlab servers](https://www.aiidalab.net/deployments/).
+- Run the AiiDAlab docker container directly [on your local machine](https://aiidalab.readthedocs.io/en/latest/usage/index.html#usage-run-locally).
+
+Once you are in the AiiDAlab platform, you can find the app in the App Store.
+[Install it and launch it from there](https://aiidalab.readthedocs.io/en/latest/usage/index.html#install-a-new-app).
+
+Here may go with a few examples of how to use the app.

{{cookiecutter.repo_name}}/docs/requirements.txt

@@ -0,0 +1 @@
+mkdocs-material~=9

{{cookiecutter.repo_name}}/docs/tutorial.md

@@ -0,0 +1,3 @@
+# Tutorial
+
+Here may go a few notes on how to use the app.

{{cookiecutter.repo_name}}/mkdocs.yml

@@ -0,0 +1,9 @@
+site_name: Pseudopotential optimization
+nav:
+  - Home: index.md
+  - Tutorial: tutorial.md
+  - Development: development.md
+theme:
+  name: material
+markdown_extensions:
+  - footnotes

{{cookiecutter.repo_name}}/ruff.toml

@@ -0,0 +1,19 @@
+target-version = "py39"
+
+[lint]
+extend-select = [
+  "UP",  # pyupgrade
+  "D",   # pydocstyle
+]
+
+ignore = [
+    "UP009",
+    "D205",
+    "D212",
+    "D415",
+    "D100",
+    "D103",
+]
+
+[lint.pydocstyle]
+convention = "google"