BritishGeologicalSurvey / etlhelper

ETL Helper is a Python ETL library to simplify data transfer into and out of databases.
https://britishgeologicalsurvey.github.io/etlhelper/
GNU Lesser General Public License v3.0
100 stars 25 forks source link

Update docs code demos #201

Closed leorudczenko closed 3 months ago

leorudczenko commented 3 months ago

Summary

This merge request moves all of the code demo snippets in the docs/ from their .rst files into individual Python files in docs/code_demos/. These are then included in the pages using the sphinx method literalinclude. This means that it is easier for us to spot formatting errors in these scripts, largely because now we can run them against flake8.

Description

For this to be achieved, a number of changes have been made to the directory structure in docs/ regarding Python files:

Some additional changes have also been made to support these changes:

Acceptance Criteria

volcan01010 commented 3 months ago

I built the docs locally and it all worked. Nice one! I like the little module-level docstrings at the top of each file.