Python Project Template
latest

App's Documentation:

  • Documenting your application
    • User Documentation
      • Brief Description
      • How to install
      • Main features
      • Screenshots
      • How to get help
      • Frequently asked questions
    • Developer’s Documentation
      • Navigating the codebase
      • Flow diagrams
      • Important parts of your code

Workflow & Template:

  • Workflow
    • Continuous Integration
      • Travis & Codecov configuration
        • Linking Travis and Codecov
    • Code Conventions
      • Discussing disabled linter warnings
        • bad-whitespace
        • len-as-condition
        • no-name-in-module
    • Project Structure
      • Use namespaces

Tools:

  • Standard Tools
    • Code Coverage based on Unit Tests
      • Coverage Makefile Targets
      • Uploading to Codecov.io
      • Codecoverage as a Check in GitHub
      • Discussion on Coverage Targets
        • The app
        • The tests
        • The tools
    • Linter & Code Quality
    • Unit Tests
      • Deep dive on the test results
        • Skipped
        • Expected Fails
        • Errors
    • Documenting your project with Sphinx and reStructuredText
  • Custom Tools
    • Python Project Cleaner
      • Introduction
      • How to clean the project tree
      • Developer’s documentation

Code Stubs (auto-generated)

  • app
    • main module
Python Project Template
  • Docs »
  • app
  • Edit on GitHub

app¶

  • main module
Next Previous

© Copyright 2019, Arthur Van de Wiele Revision 70499551.

Built with Sphinx using a theme provided by Read the Docs.