Add code to example usage section of readthedocs

best-practice-and-impact · Jun 28, 2024 · cb2d675 · cb2d675
1 parent b1285d9
commit cb2d675
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 0 deletions.
diff --git a/docs/source/usage.rst b/docs/source/usage.rst
@@ -41,6 +41,13 @@ examples_ directory of the package.
     :lines: 16-
 
 
+.. automodule:: gptables.examples.survey_data
+
+.. literalinclude:: ../../gptables/examples/survey_data.py
+    :language: python
+    :lines: 8-
+
+
 R Usage
 -------
 

diff --git a/gptables/examples/survey_data.py b/gptables/examples/survey_data.py
@@ -1,3 +1,11 @@
+"""
+Labour market overview, UK: December 2020 - Real Survey Data Example
+--------------------------------------------------------------------
+
+This example demonstrates how to replicate the Labour Market overview accessible 
+example found at https://analysisfunction.civilservice.gov.uk/policy-store/further-resources-for-releasing-statistics-in-spreadsheets/
+"""
+
 import gptables as gpt
 import pandas as pd
 import numpy as np