Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
381 changes: 42 additions & 339 deletions docs/conf.py

Large diffs are not rendered by default.

12 changes: 7 additions & 5 deletions docs/data_fields.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@ Depending on the detail published, this field may include the name of the organs
The name used for the same organisation may vary between reporting organisations.
For example, AfDB, African Development Bank, African Development Bank Group, etc.

Where organisations do not declare a :iati-reference:`provider-org` for a transaction, the logic described in the Methodology; :ref:`Provider and receiver organisations` section is followed.
For budgets, the logic described in the Methodology; :ref:`Budget Handling` section is followed.
Where organisations do not declare a :iati-reference:`provider-org` for a transaction, the logic described in the Methodology; :ref:`Provider and receiver organisations <prov_rec>` section is followed.
For budgets, the logic described in the Methodology; :ref:`Budget Handling <budgets>` section is followed.


Provider Organisation Type
Expand All @@ -72,8 +72,8 @@ Receiver Organisation
The organisation receiving the specified transaction amount.
Depending on the detail published, this field may include the name of the organsation, their unique organisation identifier, or both.

Where organisations do not declare a :iati-reference:`receiver-org` for a transaction, the logic described in the Methodology; :ref:`Provider and receiver organisations` section is followed.
For budgets, the logic described in the Methodology; :ref:`Budget Handling` section is followed.
Where organisations do not declare a :iati-reference:`receiver-org` for a transaction, the logic described in the Methodology; :ref:`Provider and receiver organisations <prov_rec>` section is followed.
For budgets, the logic described in the Methodology; :ref:`Budget Handling <budgets>` section is followed.

Receiver Organisation Type
===========================
Expand Down Expand Up @@ -106,7 +106,7 @@ Multi Country
Indicates whether the activity has one or multiple recipient countries, where 1 = True and 0 = False.
If it is a multi-country activity, this means that the estimated percentage to that country has been applied to the transaction / budget values.

The logic of transaction splitting is described in the Methodology; :ref:`Transaction Splitting` section.
The logic of transaction splitting is described in the Methodology; :ref:`Transaction Splitting <trans_split>` section.

Sector Category
================
Expand All @@ -128,6 +128,8 @@ Calendar Year
==============
The year in which the transaction occurred or the year for which the budget values have been aggregated.

.. _cal quarters:

Calendar Quarter
=================
This is the quarter in which the transaction occurred or the quarter for which the budget values have been aggregated.
Expand Down
7 changes: 3 additions & 4 deletions docs/example_queries.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Example Queries
|

.. _q1:
1: How do I find organisations involved in humanitarian responses?
1: How do I find organisations involved in humanitarian responses?
-------------------------------------------------------------------

A Local NGO is looking to coordinate with other organisations. They want to find a list of organisations who are supporting the humanitarian response in Lebanon.
Expand Down Expand Up @@ -40,12 +40,11 @@ The `resulting table <https://countrydata.iatistandard.org/data/custom/?drilldow
.. note::
If :iati-reference:`provider-org` or :iati-reference:`receiver-org` are not specified for individual transactions,
CDFD will populate these fields using the reporting and participating organisations elements.
See the Methodology section on :ref:`Provider and receiver organisations` for more information.
See the Methodology section on :ref:`Provider and receiver organisations <prov_rec>` for more information.

|

.. _q2:
2: What external resources were spent in 2021 Q4 in Zimbabwe?
2: What external resources were spent in 2021 Q4 in Zimbabwe?
-------------------------------------------------------------------

The Ministry of Finance in Zimbabwe needs data on external inflows to the country to feed into the quarterly calculation of Balance of Payments.
Expand Down
6 changes: 5 additions & 1 deletion docs/processing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ Data Processing

This section outlines how IATI data is processed by CDFD.

.. _trans_split:

Transaction Splitting
===========================

Expand Down Expand Up @@ -82,7 +84,7 @@ When correcting percentages for countries/regions, the following logic is used:
Aggregation
============

Once split by country/region and sector, transactions and budgets are aggregated into calendar years and :ref:`calendar quarters<Calendar Quarter>`.
Once split by country/region and sector, transactions and budgets are aggregated into calendar years and :ref:`calendar quarters<cal quarters>`.

Each row is the quarterly/yearly aggregation where all other data fields are the same.
This means that the quarter may be split across multiple rows, such as in the multi-sector `activity <https://countrydata.iatistandard.org/data/custom/?drilldowns=recipient_country_or_region%3Bactivity.iati_identifier%3Bactivity.title%3Bsector%3Bcalendar_year_and_quarter.calendar_year_and_quarter&filters=activity.iati_identifier%3AXM-DAC-928-AL-2022-23-01.001.EU01.ALB01%3Bcalendar_year_and_quarter%3A2022%20Q1%3Btransaction_type%3A3,4,budget&displayAs=table>`_ shown below:
Expand All @@ -107,6 +109,8 @@ Budget values are converted using the closest date to the budget :iati-reference

Monthly exchange rates for 169 currencies are sourced from the IMF's `International Financial Statistics <https://data.imf.org/en?sk=4C514D48-B6BA-49ED-8AB9-52B0C1A0179B>`_.

.. _budgets:

Budget Handling
======================

Expand Down
2 changes: 2 additions & 0 deletions docs/retrieval.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,8 @@ For some elements, the data can be declared at transaction or activity level. Tr

|

.. _prov_rec:

Provider and receiver organisations
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down
4 changes: 3 additions & 1 deletion requirements.in
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
sphinx
sphinx-togglebutton
sphinxcontrib-opendataservices
sphinxcontrib-video
sphinxcontrib-youtube
sphinx-intl
iati-sphinx-theme
iati-sphinx-theme
19 changes: 13 additions & 6 deletions requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@
#
alabaster==1.0.0
# via sphinx
attrs==25.4.0
attrs==25.3.0
# via referencing
babel==2.17.0
# via
# sphinx
# sphinx-intl
certifi==2025.10.5
# via requests
charset-normalizer==3.4.4
charset-normalizer==3.4.3
# via requests
click==8.3.0
# via sphinx-intl
Expand All @@ -25,9 +25,9 @@ docutils==0.21.2
# sphinx-togglebutton
# sphinxcontrib-opendataservices
# sphinxcontrib-opendataservices-jsonschema
iati-sphinx-theme==3.1.1
iati-sphinx-theme==3.1.0
# via -r requirements.in
idna==3.11
idna==3.10
# via requests
imagesize==1.4.1
# via sphinx
Expand Down Expand Up @@ -67,12 +67,13 @@ pygments==2.19.2
# via sphinx
pyyaml==6.0.3
# via myst-parser
referencing==0.37.0
referencing==0.36.2
# via sphinxcontrib-opendataservices-jsonschema
requests==2.32.5
# via
# jscc
# sphinx
# sphinxcontrib-youtube
roman-numerals-py==3.1.0
# via sphinx
rpds-py==0.27.1
Expand All @@ -86,6 +87,8 @@ sphinx==8.2.3
# sphinx-intl
# sphinx-togglebutton
# sphinxcontrib-opendataservices
# sphinxcontrib-video
# sphinxcontrib-youtube
sphinx-intl==2.3.2
# via -r requirements.in
sphinx-togglebutton==0.3.2
Expand All @@ -106,10 +109,14 @@ sphinxcontrib-qthelp==2.0.0
# via sphinx
sphinxcontrib-serializinghtml==2.0.0
# via sphinx
sphinxcontrib-video==0.4.1
# via -r requirements.in
sphinxcontrib-youtube==1.4.1
# via -r requirements.in
urllib3==2.5.0
# via requests
wheel==0.45.1
# via sphinx-togglebutton

# The following packages are considered to be unsafe in a requirements file:
# setuptools
# setuptools
17 changes: 12 additions & 5 deletions requirements_dev.txt
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ anyio==4.11.0
# via
# starlette
# watchfiles
attrs==25.4.0
attrs==25.3.0
# via
# -r requirements.txt
# referencing
Expand All @@ -27,7 +27,7 @@ certifi==2025.10.5
# via
# -r requirements.txt
# requests
charset-normalizer==3.4.4
charset-normalizer==3.4.3
# via
# -r requirements.txt
# requests
Expand All @@ -49,9 +49,9 @@ docutils==0.21.2
# sphinxcontrib-opendataservices-jsonschema
h11==0.16.0
# via uvicorn
iati-sphinx-theme==3.1.1
iati-sphinx-theme==3.1.0
# via -r requirements.txt
idna==3.11
idna==3.10
# via
# -r requirements.txt
# anyio
Expand Down Expand Up @@ -126,7 +126,7 @@ pyyaml==6.0.3
# via
# -r requirements.txt
# myst-parser
referencing==0.37.0
referencing==0.36.2
# via
# -r requirements.txt
# sphinxcontrib-opendataservices-jsonschema
Expand All @@ -135,6 +135,7 @@ requests==2.32.5
# -r requirements.txt
# jscc
# sphinx
# sphinxcontrib-youtube
roman-numerals-py==3.1.0
# via
# -r requirements.txt
Expand All @@ -157,6 +158,8 @@ sphinx==8.2.3
# sphinx-intl
# sphinx-togglebutton
# sphinxcontrib-opendataservices
# sphinxcontrib-video
# sphinxcontrib-youtube
sphinx-autobuild==2025.8.25
# via -r requirements_dev.in
sphinx-intl==2.3.2
Expand Down Expand Up @@ -193,6 +196,10 @@ sphinxcontrib-serializinghtml==2.0.0
# via
# -r requirements.txt
# sphinx
sphinxcontrib-video==0.4.1
# via -r requirements.txt
sphinxcontrib-youtube==1.4.1
# via -r requirements.txt
starlette==0.48.0
# via sphinx-autobuild
urllib3==2.5.0
Expand Down