Merge pull request #65 from ns-rse/sphinx-docs

Sphinx docs

.markdownlint-cli2.yaml

@@ -0,0 +1,18 @@
+# Configuration
+config:
+  # MD013 - line-length
+  line_length:
+    line_length: 120
+    code_blocks: false
+    tables: false
+  html:
+    allowed_elements:
+      - div
+
+# Globs
+globs:
+  - "**/*.md"
+  - "**/*.qmd"
+
+# Fix any fixable errors
+fix: false

.pre-commit-config.yaml

@@ -1,11 +1,17 @@
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
--   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.4.0
-    hooks:
+- repo: https://github.com/pre-commit/pre-commit-hooks
+  rev: v4.4.0
+  hooks:
     - id: trailing-whitespace
     - id: end-of-file-fixer
     - id: check-yaml
     - id: check-added-large-files
       args: ['--maxkb=2048']
+
+- repo: https://github.com/DavidAnson/markdownlint-cli2
+  rev: v0.6.0
+  hooks:
+    - id: markdownlint-cli2
+      args: [.markdownlint-cli2.yaml]

posts/pre-commit/index.qmd

@@ -4,6 +4,17 @@ author: "nshephard"
 date: "2022-08-28"
 categories: [code, analysis, linting, git, github, gitlab]
 image: https://live.staticflickr.com/65535/52294716597_ea3be238c0_k.jpg
+from: markdown+emoji
+toc: true
+toc-depth: 4
+toc-location: right
+execute:
+  code_fold: true
+  code_link: true
+  code_tools: true
+  fig-cap-location: top
+  tbl-cap-location: top
+  warning: false
 ---
 
 [Pre-commit](https://pre-commit.com/) is a powerful tool for executing a range of hooks prior to making commits to your
@@ -263,8 +274,6 @@ If you use GitLab the following article describes how to configure a CI job to r
 * [How to use pre-commit to automatically correct commits and merge requests with GitLab CI](https://stackoverflow.com/collectives/gitlab/articles/71270196/how-to-use-pre-commit-to-automatically-correct-commits-and-merge-requests-with-g)
 
 
-
-
 ## Links
 
 * [Pre-commit](https://pre-commit.com/)

posts/python-packaging/index.qmd

@@ -20,6 +20,8 @@ execute:
 This post describes steps in creating a [Python](https://www.python/org) package. If you are looking for information on
 installing packages this is done using [Python PIP](https://pypi.org/).
 
+![[_Water and Light_ - Picture by Me](https://www.flickr.com/photos/slackline/52595884731/)](https://live.staticflickr.com/65535/52595884731_fb5c7d576e_k.jpg)
+
 [Python](https://www.python/org) packaging is in a constant state of flux. There is the official [Python
 Packaging User Guide](https://packaging.python.org/en/latest/) and the [Python Packaging
 Authority (PyPA)](https://www.pypa.io/en/latest/) which is probably the best resource to read but things change, and often
@@ -529,3 +531,4 @@ used it.
 - [Why you shouldn\'t invoke setup.py directly](https://blog.ganssle.io/articles/2021/10/setup-py-deprecated.html)
 - [python-versioneer/python-versioneer: version-string management for VCS-controlled trees](https://github.com/python-versioneer/python-versioneer)
 - [pypa/setuptools~scm~: the blessed package to manage your versions by scm tags](https://github.com/pypa/setuptools_scm)
+- [rye one-shop-stop for Python](https://github.com/mitsuhiko/rye)