foobar

Author:pyfidelity UG Version:0.0

Bootstrapping

Start here to join the team and get a local development intance up and running.

• Installation
  • Development Requirements
  • Bootstrapping
  • Starting up
• Team Resources
  • Git Access
  • Issues
  • IRC

Developing the backend

Continue here, if you develop the application

• Development Conventions
  • Basic conventions
  • Testing
  • Documentation
    • Building the documentation
• Restful Services
  • Schemas and validation
  • Declaring resources
  • Exposing resources
• API Documentation
  • Public API
    • Signup
    • Login
    • Password reset
    • Password change
    • Email change
    • User profile
  • Base API Classes
  • Base Models

Developing the frontend

Continue here, if you develop the frontend application

• Frontend
• Debugging the frontend build

Reference

Keep these under your pillow :)

• Architecture
  • URL authority

Documentation

(This) documentation is maintained with sphinx. When writing documentation, please see the sections reStructuredText Primer and especially Inline markup of the sphinx documentation for hints about how to format sections etc.

See PEP 257 for docstring conventions.

The majority of the documentation should be in the code! The .rst files should be only used for meta topics – such as this, regarding documentation ;-) – or deployment etc.

Doc strings should start with a short sentence describing the purpose and/or reason of the method, followed by the same for each parameter (see sphinx autoclass documentation and the sphinx Python domain on how to format those.)

Building the documentation

Before merging work you need to make sure the documentation you added doesn’t break anything. Do this by generating it locally by running:

$ make docs

Make sure that doesn’t result in erros or warnings and then run:

$ open docs/htdocs/index.html

to open it in your browser to see what it looks like.