diff --git a/doc/index.rst b/doc/index.rst new file mode 100644 index 0000000000..e2a71eb272 --- /dev/null +++ b/doc/index.rst @@ -0,0 +1,22 @@ + + +Country Module +############## + +The country module defines the concepts of country and subdivision and +comes preloaded with the ISO 3166 list of countries and subdivisions +thanks to the pycountry module. + + +Country +******* + +A country is defined by the full name of the country, a code (the ISO +country code made of two chars) and the list of subdivisions. + + +Subdivision +*********** + +A subdivision is defined by a name, a code and a type (e.g, Capital +City, Province, Emirate, etc)