File: index.rst

package info (click to toggle)
bootstrap-flask 2.2.0%2Bds1-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 25,396 kB
  • sloc: python: 2,218; makefile: 24
file content (88 lines) | stat: -rw-r--r-- 1,515 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
Bootstrap-Flask
===============

Bootstrap-Flask is a collection of Jinja macros for Bootstrap and Flask. It helps you to
render Flask-related data and objects to Bootstrap markup HTML more easily.


Contents
--------

.. toctree::
   :maxdepth: 2

   basic
   macros
   migrate
   advanced
   examples


API Reference
-------------

If you are looking for information on a specific function, class or
method, this part of the documentation is for you.

.. toctree::
   :maxdepth: 2

   api


Changelog
---------

.. toctree::
   :maxdepth: 2

   changelog


Development
-----------

We welcome all kinds of contributions. You can build the development environment
locally with the following commands:

.. code-block:: bash

    $ git clone git@github.com:helloflask/bootstrap-flask.git
    $ cd bootstrap-flask
    $ python3 -m venv venv
    $ . venv/bin/activate
    $ pip install -e .
    $ pip install -r requirements/dev.txt

Run the tests with pytest:

.. code-block:: bash

    $ pytest

Or run the full checks with tox:

.. code-block:: bash

    $ tox


Authors
-------

Maintainers:

- `Grey Li <https://github.com/greyli>`_
- `Pander <https://github.com/PanderMusubi>`_

See also the list of
`contributors <https://github.com/helloflask/bootstrap-flask/contributors>`_
who participated in this project.


License
-------

This project is licensed under the MIT License (see the ``LICENSE`` file for
details). Some macros were part of Flask-Bootstrap and were modified under
the terms of its BSD License.