---

Welcome to cookietemple’s documentation!

Contents:

• cookietemple overview
  • Installing
  • config
  • list
  • info
  • create
  • lint
  • bump-version
  • sync
  • warp
  • upgrade
  • Projects using cookietemple
  • Contributing
  • Authors
• Installation
  • Stable release
  • From sources
  • Upgrading cookietemple
  • Windows Installation
• Create a project
  • Usage
  • Flags
• Getting information about available templates
  • list
    • Usage
  • info
    • Usage
• Linting your project
  • Usage
  • Flags
  • Linting codes
    • General
      • general-1
      • general-2
      • general-3
      • general-4
      • general-5
      • general-6
      • general-7
    • cli-python
      • cli-python-1
      • cli-python-2
      • cli-python-3
    • cli-java
      • cli-java-1
      • cli-java-2
    • lib-cpp
      • lib-cpp-1
      • lib-cpp-2
    • web-python
      • web-python-1
      • web-python-2
    • gui-java
      • gui-java-1
      • gui-java-2
    • pub-thesis
      • pub-thesis-1
      • pub-thesis-2
• Bumping the version of an existing project
  • Usage
  • Flags
  • Configuration
• Syncing your project
  • Requirements for sync
  • Usage
  • Flags
  • Configuring sync
    • Enable/Disable sync
    • Sync level
    • Blacklisting files
• Packaging using warp
  • Warp setup
  • Usage
  • Flags
• Configure cookietemple
  • Usage
  • Flags
  • On Github personal access tokens
• Upgrade cookietemple
  • Usage
• Available templates
  • cli-python
    • Purpose
    • Design
    • Included frameworks/libraries
    • Usage
    • FAQ
      • Do I need a command line interface?
      • flake8 and darglint are very slow
  • cli-java
    • Purpose
    • Design
    • Included frameworks/libraries
    • Usage
    • FAQ
      • Can I use cli-java without GraalVM?
      • How can I access the build artifacts?
  • gui-java
    • Purpose
    • Design
    • Included frameworks/libraries
    • Usage
    • FAQ
  • lib-cpp
    • Purpose
    • Design
    • Included frameworks/libraries
    • Usage
      • Installing
      • Building the project
      • Generating the documentation
      • Running tests
    • FAQ
  • pub-thesis-latex
    • Purpose
    • Design
    • Included frameworks/libraries
    • Usage
      • Building your thesis - LaTeX / PDFLaTeX
        • Using latexmk (Unix/Linux/Windows)
        • Using the make file (Unix/Linux)
        • Shell script for PDFLaTeX (Unix/Linux)
        • Using the batch file on Windows OS (PDFLaTeX)
      • Building your thesis - XeLaTeX
        • Using latexmk (Unix/Linux/Windows)
      • Building your thesis - LuaLaTeX
        • Using latexmk (Unix/Linux/Windows)
      • Usage details
        • Class options
        • Title page
        • Abstract separate
        • Chapter mode
        • Draft
        • Choosing the fonts
        • Choosing the bibliography style
        • Choosing the page style
        • Changing the visual style of chapter headings
        • Custom settings
        • Nomenclature definition
      • Git hooks
      • General guidelines
  • web-website-python
    • Purpose
    • Design
      • The basic setup
      • The advanced setup
    • Included frameworks/libraries
    • Usage
      • The basic template usage
      • The advanced template usage
    • Automatic Deployment
    • FAQ
  • Shared FAQ
    • What are the available domains?
    • How do I publish my documentation?
      • Read the Docs
      • Github Pages
    • What is Dependabot and how do I set it up?
    • Release Drafter
    • How do I add a new template?
• Github Support
  • Overview
  • Branches
    • Overview
    • Branch protection rules
  • Github Actions
    • Overview
    • main_master_branch_protection workflow
    • release drafter workflow
    • sync_project.yml
  • Secrets
    • Error Handling due to failed Github repository creation
  • Issue labels
• Contributing
  • Types of Contributions
    • Report Bugs
    • Fix Bugs
    • Implement Features
    • Add Templates
    • Write Documentation
    • Submit Feedback
  • Get Started!
  • Pull Request Guidelines
  • Tips
• Adding new templates
  • Template requirements
  • Step by step guide to adding new templates
• External Python based projects
• FAQ
  • I need help with cookietemple. How can I get in contact with the developers?
  • I am looking for a template for domain x and language y, but it does not exist yet!
• Troubleshooting
• Community
  • Development Leads
  • Core contributors
  • Contributors
• Contributor Covenant Code of Conduct
  • Our Pledge
  • Our Standards
  • Our Responsibilities
  • Scope
  • Enforcement
  • Attribution

Indices and tables

• Index

• Module Index

• Search Page