Skip to content

Commit

Permalink
First cut of documentation pages
Browse files Browse the repository at this point in the history
  • Loading branch information
timgdavies committed Jan 3, 2017
1 parent 1d3cff2 commit 615ef7b
Show file tree
Hide file tree
Showing 20 changed files with 499 additions and 0 deletions.
7 changes: 7 additions & 0 deletions .sublime-project
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"settings":
{
"spell_check": true,
"dictionary": "Packages/Language - English/en_US.dic"
}
}
14 changes: 14 additions & 0 deletions docs/_exts/__init__.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# -*- coding: utf-8 -*-
"""
sphinxcontrib
~~~~~~~~~~~~~
This package is a namespace package that contains all extensions
distributed in the ``sphinx-contrib`` distribution.
:copyright: Copyright 2007-2009 by the Sphinx team, see AUTHORS.
:license: BSD, see LICENSE for details.
"""

__import__('pkg_resources').declare_namespace(__name__)

Binary file added docs/_exts/__pycache__/doctabs.cpython-35.pyc
Binary file not shown.
59 changes: 59 additions & 0 deletions docs/_exts/doctabs.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
# Adapted from the doctabs directive

# -*- coding: utf-8 -*-
"""
Examplecode specs
=================
"""
import os
from docutils.parsers.rst import Directive
from docutils import nodes
from sphinx.util.osutil import copyfile


CSS_FILE = 'doctabs.css'
JS_FILE = 'doctabs.js'


class DocTabsDirective(Directive):
"""
This directive is intended to be used to contain a group of
blocks which are being used to show code examples in many different
languages. When rendered as HTML the the examples will all be rolled up
into a single display area with buttons to select between the different
languages.
"""

has_content = True

def run(self):
self.assert_has_content()
text = '\n'.join(self.content)
node = nodes.container(text)
node['classes'].append('doc-tabs')
self.add_name(node)
self.state.nested_parse(self.content, self.content_offset, node)
return [node]


def add_assets(app):
app.add_stylesheet(CSS_FILE)
app.add_javascript(JS_FILE)

def copy_assets(app, exception):
if app.builder.name != 'html' or exception:
return
app.info('Copying doctabs stylesheet/javascript... ', nonl=True)
dest = os.path.join(app.builder.outdir, '_static', CSS_FILE)
source = os.path.join(os.path.abspath(os.path.dirname(__file__)), CSS_FILE)
copyfile(source, dest)
dest = os.path.join(app.builder.outdir, '_static', JS_FILE)
source = os.path.join(os.path.abspath(os.path.dirname(__file__)), JS_FILE)
copyfile(source, dest)
app.info('done')

def setup(app):
app.add_directive('doc-tabs', DocTabsDirective)
app.connect('builder-inited', add_assets)
app.connect('build-finished', copy_assets)

55 changes: 55 additions & 0 deletions docs/about.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,59 @@
About
=====

```eval_rst
.. image:: assets/IOAF_logo_color_RGB.jpg
:width: 300 px
:height: 133 px
:alt: Project Logo
:align: center
```

<p></p>

The [Initiative for Open Ag Funding](https://www.interaction.org/project/open-ag-funding/overview) is working to make sure that development actors working in agriculture and food security have the data they need to make smarter investment decisions, and to ultimately end hunger and food insecurity.

You can [read more about the Initiative here](https://www.interaction.org/project/open-ag-funding/overview).


```eval_rst
.. image:: assets/project-toc.png
:alt: Project theory of change
:align: center
```

## The Open Ag Funding data framework
On this site you can find out **how to publish and use Open Ag Funding data** that is fit for purpose to support donor co-ordination and more effective use of resources for agricultural development and food security.

You can:

* Read more about [how we are building on the International Aid Transparency Initiative (IATI) data standard](iati.md);
* Explore the 20 data elements needed for effective Open Ag Funding data;
* View the technical documentation on how to prepare your data in XML or spreadsheet formats;
* Read background research from the project



## Share your data

**Does your organization provides funding for agricultural development or food security?** If so - we need your data.

If you already publish data using the IATI standard, you can enhance your existing data to make it Open Ag ready.

If you do not currently publish structured data on your funding or investments, you can [follow these simple steps to plan out new open data publication](ADD LINK ADD LINKS).

Not sure why you would share your data? Read more here about the benefits.

Looking for support to publish? We're offering free publisher support during 2017.

## Explore Open Ag Funding Data

Over 2017 we will be supporting the development of a range of tools that can help you explore and analyze data published according to the Open Ag Funding framework.

Check back for details of tools here later in 2017, or [get in touch](contact.md) to let us know about the data analysis you want to be able to carry out, and we'll see if we can signpost you to existing resources.

## Interested in other datasets?

The [International Aid Transparency Initiative](http://www.aidtransparency.net) brings together data from 100s or donors on funding for development.

The [Global Open Data for Agriculture and Nutrition](http://www.godan.info) network supports advocacy and action on open data across the agriculture sector.
Binary file added docs/assets/IOAF_logo_color_RGB.jpg
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/iati-logo.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/project-toc.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions docs/codelists.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Codelists
=========
6 changes: 6 additions & 0 deletions docs/contact.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Contact
=======

If you want to know more about the Open Ag Funding project overall, please contact lead partner, Interaction, using the [contact details on the project website here](https://www.interaction.org/project/open-ag-funding/overview).

For questions about the data quality framework, get in touch with [Steven Flower](mailto:steven.flower@opendataservices.coop)
Binary file not shown.
Binary file not shown.
32 changes: 32 additions & 0 deletions docs/examples/US-1-TZ-50-AID-621-TO-11-05000.csv
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
Activity ID,Reporting Organisation,,,,Activity Title,Activity Descriptions,,,Activity Status,,,Activity Dates,,Participating Organisations,,,,Location (Country/Region),,,,,Aid classifications,,,,,Sector Classification,,,,Documents,,,,,,Budget,,,,,,Transaction,,,,,,Transaction parties (participating organisations),,,,,,Transaction Traceability,,Transaction classification,,,Sub-national location,,,,,,,,,,,,,,,Results information,,,,,,,,,,Contact details,,,,,,,
Activity ID,Reporting Org Name,Reporting Org Ref,Reporting Org Type,Secondary Reporter,Activity Title,Activity Description,Description Language,Description Type Code,Activity Status Code,Default Lang,Default Currency,Activity Date,Activity Date Type,Participating Org Name,Participating Org Ref,Participating Org Type,Participating Org Role,Country Code,Region Code,Country Region Percentage,Region Vocabulary,Region Vocabulary URI,Collaboration Type,Default Flow Type,Default Finance Type,Default Aid Type,Default Tied Status,Sector Code,Sector Percentage,Sector Vocabulary,Sector Vocabulary URI,Document Title,Document URL,Document Category Code,Document Language Code,Document Format Code,Document Date,Budget Type,Budget Start Date,Budget End Date,Budget Value,Budget Currency,Budget Value Date,Transaction Type,Transaction Date,Transaction Value,Transaction Currency,Transaction Value Date,Transaction Description,Transaction Provider Name,Transaction Provider Type,Transaction Provider Ref,Transaction Receiver Name,Transaction Receiver Type,Transaction Receiver Ref,Transaction Provider Activity Ref,Transaction Receiver Activity Ref,Transaction Sector Code,Transaction Sector Vocabulary,Transaction Sector Vocabulary URI,Location Ref,Location Reach Code,Location ID Code,Location ID Vocabulary,Location Name,Location Description,Location Activity Description,Location Admin Code,Location Admin Vocabulary,Location Admin Level,Point srsName,Pos,Exactness Code,Location Class Code,Feature Designation Code,Result Type,Result Title,Result Description,Indicator Title,Indicator Measure,Indicator Ascending,Indicator Description,Indicator Reference Code,Indicator Reference Vocabulary,Indicator Reference Vocabulary URI,Contact Info Type,Contact Organisation,Contact Person Name,Contact Job Title,Contact Telephone,Contact Email,Contact Mailing Address,Contact Website
US-1-TZ-50-AID-621-TO-11-05000,U.S. Agency for International Development,US-1,10,0,Tanzania Staples Value Chain (NAFAKA),"The NAFAKA Staples Value Chain Activity is a five-year Task Order issued by USAID under the Tanzania Feed the Future (FtF) Initiative and administered by ACDI/VOCA. NAFAKA integrates agricultural, gender, environment and nutritional development efforts to improve smallholder farmer productivity and profitability within the rice and maize value chains in Morogoro (Kilombero and Mvomero Districts), Dodoma (Kongwa District) and Manyara (Kiteto District) on the mainland, as well as Pemba and Unguja in Zanzibar. NAFAKA’s goal is to sustainably reduce poverty and food insecurity by increasing incomes for smallholder farmers, including men, women, and youth.

NAFAKA aligns with the Feed the Future (FtF) goal to harmonize regional hunger- and poverty-fighting efforts in countries with chronic food insecurity and insufficient production of staple crops. NAFAKA works with rural communities and the Government of Tanzania to analyze the local rice and maize value chains and to develop strategies to strengthen them. NAFAKA represents a commitment to Tanzania’s country-led Kilimo Kwanza initiative to reinvigorate agricultural growth emerging from the Comprehensive Africa Agriculture Development Programme (CAADP) process.",en,1,2,en,USD,2011-04-08,2,USA,US-USAGOV,10,1,TZ,,100,,,1,10,110,C01,5,31161,100,1,http://www.oecd.org/dac/stats/dacandcrscodelists.htm,"NAFAKA Staples Value Chain Activity: Annual Performance Report (October 1, 2014 – September 30, 2015)",http://pdf.usaid.gov/pdf_docs/pa00ks35.pdf,A07,en,application/pdf,2015-09-30,1,2011-04-08,2012-04-07,3000000,USD,2011-04-08,2,2011-04-08,34800000,USD,2011-04-08,,U.S. Agency for International Development,10,US-1,ACDI/VOCA,21,US-EIN-52-0811461,US-1-TZ-50-AID-621-TO-11-05000,US-EIN-13-3287064NAM-ACDI-TZ-11-2780,31161,1,http://www.oecd.org/dac/stats/dacandcrscodelists.htm,?,2,0503,G1,Kilombero District,"Kilombero District, Morogoro","Kilombero District: a paddy-growing area in the south of the Morogoro region with five clusters. In Ifakara North, Mlimba, and Mang’ula clusters, NAFAKA is engaged in association development and increasing productivity in 56 villages (20 in Ifakara North, 16 in Mlimba, and 20 in Mang’ula), focused mainly on rain-fed production.",0503,G1,2,,,1,1,ADM2,2,,,Gross margin per hectare,1,1,,"4.5-16, 17, 18",3,http://www.state.gov/f/indicators/,1,U.S. Agency for International Development,Crystal Garrett,"Tanzania Officer-in-Charge, Office of East African Affairs",1 202-712-0371,cgarrett@usaid.gov,"1300 Pennsylvania Ave NW, Washington DC 20004",https://www.usaid.gov/tanzania
,,,,,,"Goal:
To sustainably reduce poverty and hunger by improving the productivity and competitiveness of value chains that offer job and income opportunities for rural households.

Objectives:
Improve the competitiveness and productivity of the rice and maize value chains.
Improve domestic and regional trade in rice and maize.
Expand the depth and breadth of benefits from the growth of the rice and maize subsectors, including increased benefits to women and youth.
Enhance rural household nutrition by promoting women-focused value chain development and improved consumption of a quality diet.",en,2,,,,2016-04-07,3,U.S. Agency for International Development,US-1,10,2,,,,,,,,,,,,,,,"NAFAKA Staples Value Chain Activity: Annual Performance Report (October 1, 2013 – September 30, 2014)",http://pdf.usaid.gov/pdf_docs/pa00ks34.pdf,A07,en,application/pdf,2014-10-10,1,2012-04-08,2013-04-07,11000000,USD,2012-04-08,3,2015-12-31,257051.44,USD,2015-12-31,,U.S. Agency for International Development,10,US-1,ACDI/VOCA,21,US-EIN-52-0811461,US-1-TZ-50-AID-621-TO-11-05000,US-EIN-13-3287064NAM-ACDI-TZ-11-2780,31161,1,http://www.oecd.org/dac/stats/dacandcrscodelists.htm,?,2,0506,G1,Mvomero District,"Mvomero District, Morogoro",Mvomero District: a paddy- and maizegrowing area in the north of the Morogoro region. NAFAKA is developing associations and increasing productivity with both paddy (rainfed and irrigated) and maize producers in 48 villages.,0506,G1,2,,,1,1,ADM2,2,,,Yields: kg per hectare,1,1,,,99,,,,,,,,,
,,,,,,"Smallholder farmers, including men, women and youth",en,3,,,,2017-04-07,4,U.S. Agency for International Development,US-1,10,3,,,,,,,,,,,,,,,CRS Tanzania NAFAKA Barrier Analysis Report,http://pdf.usaid.gov/pdf_docs/pa00kxxj.pdf,?,en,application/pdf,2012-05-05,1,2013-04-08,2014-04-07,10300000,USD,2013-04-08,,,,,,,,,,,,,,,5005,99,,?,2,0103,G1,Kongwa District,"Kongwa District, Dodoma",Maize-growing area in Dodoma. NAFAKA is developing associations and increasing productivity with maize producers in 61 villages in Kongwa.,0103,G1,2,,,1,1,ADM2,1,,,Number of individuals who have received USG supported short-term agricultural sector productivity or food security training,1,1,,4.5.2-7,3,http://www.state.gov/f/indicators/,,,,,,,,
,,,,,,"Subsistence smallholder farmers: Smallholders who own and cultivate plots ranging from 0.1 hectares to 2.0 hectares.
Medium-scale smallholder farmers: Smallholders with total landholdings between 2.1 hectares and 5 hectares.",en,3,,,,,,ACDI/VOCA,US-EIN-52-0811461,21,4,,,,,,,,,,,,,,,Staples Value Chain NAFAKA Activity: Consultant Report – To assess the profitability of NAFAKA RICE production technologies in irrigated and rainfed systems,http://pdf.usaid.gov/pdf_docs/pa00kwv9.pdf,?,en,application/pdf,2013-08-23,1,2014-04-08,2015-04-07,5500000,USD,2014-04-08,3,2015-12-31,1341809.5,USD,2015-12-31,,U.S. Agency for International Development,10,US-1,ACDI/VOCA,21,US-EIN-52-0811461,US-1-TZ-50-AID-621-TO-11-05000,US-EIN-13-3287064NAM-ACDI-TZ-11-2780,31161,1,http://www.oecd.org/dac/stats/dacandcrscodelists.htm,?,2,2105,G1,Kiteto District,"Kiteto District, Manyara",Maize-growing area in Manyara. NAFAKA is developing associations and increasing productivity with maize producers in 51 villages in Kiteto.,2105,G1,2,,,1,1,ADM2,2,,,Number of farmers and others who have applied improved technologies or management practices as a result of USG assistance,1,1,,4.5.2-5,3,http://www.state.gov/f/indicators/,,,,,,,,
,,,,,,,,,,,,,,Rural and Urban Development Initiative (RUDI),,22,,,,,,,,,,,,,,,,Staples Value Chain NAFAKA Activity: Consultant Report – Public-Private Partnerships and Expansion into Iringa and Mbeya Districts,http://pdf.usaid.gov/pdf_docs/pa00kwqc.pdf,?,en,application/pdf,2013-12-20,1,2015-04-08,2016-04-07,3000000,USD,2015-04-08,,,,,,,,,,,,,,,5005,99,,?,2,,,Pemba,"Pemba, Zanzibar",NAFAKA is focused on increasing productivity with both rain-fed and irrigated paddy producers in 37 wards/shehias.,,,,,,1,1,ADM2,1,,,"Number of food security private enterprises (for profit), producer organizations, water users associations, women’s groups, trade and business associations and community-based organizations (CBOs) receiving USG assistance",1,1,,4.5.2-11,3,http://www.state.gov/f/indicators/,,,,,,,,
,,,,,,,,,,,,,,Mtandao Wa Vikundi Vya Wakulima Tanzania (MVIWATA),,22,,,,,,,,,,,,,,,,Staples Value Chain Project – NAFAKA Value Chain Assessment,http://pdf.usaid.gov/pdf_docs/pa00kxzc.pdf,?,en,application/pdf,2011-07-29,1,2016-04-08,2017-04-07,2000000,USD,2016-04-08,3,2016-03-31,1518630.4,USD,2016-03-31,,U.S. Agency for International Development,10,US-1,ACDI/VOCA,21,US-EIN-52-0811461,US-1-TZ-50-AID-621-TO-11-05000,US-EIN-13-3287064NAM-ACDI-TZ-11-2780,31161,1,http://www.oecd.org/dac/stats/dacandcrscodelists.htm,?,2,,,Unguja,"Unguja, Zanzibar",NAFAKA is focused on increasing productivity with both rain-fed and irrigated paddy producers in 37 wards/shehias.,,,,,,1,1,ADM2,2,,,"Number of private enterprises (for profit), producer organizations, water users associations, women’s groups, trade and business associations and community-based organizations (CBOs) that applied improved technologies or management practices as a result of USG assistance",1,1,,4.5.2-42,3,http://www.state.gov/f/indicators/,,,,,,,,
,,,,,,,,,,,,,,Farm Input Promotions-Africa (FIPS),,22,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,5005,99,,?,,,,,,,,,,,,,,,1,,,Number of rural households benefiting directly from USG interventions,1,1,,4.5.2-13,3,http://www.state.gov/f/indicators/,,,,,,,,
,,,,,,,,,,,,,,International Fertilizer Development Center (IFDC),,21,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,1,,,Number of beneficiaries reached,1,1,,,99,,,,,,,,,
Blue text ,Made up or assumed,,,,,,,,,,,,,Danya International,,70,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,2,,,Number of hectares under improved technologies or management practices as a result of USG assistance,1,1,,4.5.2-2,3,http://www.state.gov/f/indicators/,,,,,,,,
Red text,Not sure if this is correct IATI-wise,,,,,,,,,,,,,Catholic Relief Services (CRS),,21,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,2,,,Value of incremental sales (collected at farm-level) attributed to FTF implementation in USD,1,1,,4.5.2-23,3,http://www.state.gov/f/indicators/,,,,,,,,
,,,,,,,,,,,,,,MatchMaker Associates,,70,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,1,,,Number and value of buyer agreements (informal or formal),1,1,,,99,,,,,,,,,
,,,,,,,,,,,,,,Crown Agents,,70,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,1,,,Volume sold by producer associations: MT,1,1,,,99,,,,,,,,,
,,,,,,,,,,,,,,Associates for International Resources and Development (AIRD),,70,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,1,,,Value of agricultural and rural loans,1,1,,4.5.2-29,3,http://www.state.gov/f/indicators/,,,,,,,,
,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,1,,,"Number of MSMEs, including farmers, receiving USG assistance to access loans",1,1,,4.5.2-30,3,http://www.state.gov/f/indicators/,,,,,,,,
,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,1,,,"Number of MSMEs, including farmers, receiving business development services from USG assisted sources",1,1,,4.5.2-37,3,http://www.state.gov/f/indicators/,,,,,,,,
,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,1,,,Number of public-private partnerships formed as a result of FTF assistance,1,1,,4.5.2-12,3,http://www.state.gov/f/indicators/,,,,,,,,
,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,2,,,Value of new private sector investment in the agriculture sector or food chain leveraged by FTF implementation,1,1,,4.5.2-38,3,http://www.state.gov/f/indicators/,,,,,,,,
,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,1,,,Number of vulnerable households benefitting directly from USG assistance,1,1,,4.5.2-14,3,http://www.state.gov/f/indicators/,,,,,,,,
,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,2,,,Value of savings accumulated by SILC groups under NAFAKA,1,1,,,99,,,,,,,,,
,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,,2,,,Number of beneficiaries with home gardens or alternate crops as proxy for access to nutritious foods and income,1,1,,,99,,,,,,,,,

0 comments on commit 615ef7b

Please sign in to comment.