Pull Request submission

The workflow (pages.yml) has been modified to include the installation of mkdocstrings and its associated dependencies (mkdocstrings-python and Pygments have been explicitly installed) alongside mkdocs. The deployment process remains the same, with the additional flags for control and verbosity during deployment.

Technical documentation has been produced. This is already deployed at https://onsdigital.github.io/SDG_11.2.1/

Even though it wasn't part of this ticket I've put the updated EU Method Comparison in here: docs/comparison_to_EU_method.md

And I have improved the mkdocs.yml so that it has the navigation of the technical documentation available.

Instructions

Go to https://onsdigital.github.io/SDG_11.2.1/ and review the pages. You can also install the dependencies locally and run mkdocs serve to see a local copy of the pages. (This is particularly good if you are updating the pages and don't want to have to push them to see them).

Closes or fixes

Closes #397

Code

[x] Requirements My/our code matches the requirements of the ticket
[x] Functionality: New functions meet requirements in issue ticket
[x] Code runs The code runs on my machine

Peer Review Section

[ ] All requirements install from (updated) requirements.txt
[ ] Documentation has been created and is clear - check the google Doc
[ ] Doctrings (Google format) have been created and accurately describe the function's functionality
[ ] Unit tests pass, or if not present a new ticket to create tests has been created
[ ] Code runs The code runs on reviewer's machine

Final approval (post-review)

The author has responded to my review and made changes to my satisfaction.

[ ] I recommend merging this request.

Review comments

Insert detailed comments here!

These might include, but not exclusively:

bugs that need fixing (does it work as expected? and does it work with other code that it is likely to interact with?)
alternative methods (could it be written more efficiently or with more clarity?)
documentation improvements (does the documentation reflect how the code actually works?)
additional tests that should be implemented (do the tests effectively assure that it works correctly?)
code style improvements (could the code be written more clearly?)

Your suggestions should be tailored to the code that you are reviewing. Be critical and clear, but not mean. Ask questions and set actions.

ONSdigital / SDG_11.2.1

397 mkdocstrings #414