Merge pull request #190 from BritishGeologicalSurvey/overhaul-docs

Overhaul docs
BritishGeologicalSurvey · May 8, 2024 · ddc026a · ddc026a
2 parents cbd83f3 + 238fbc9
commit ddc026a
Show file tree

Hide file tree

Showing 22 changed files with 1,323 additions and 2,433 deletions.
diff --git a/.gitignore b/.gitignore
@@ -107,3 +107,4 @@ setup_env.sh
 # mypy
 .mypy_cache/
 bin/setup_local_env.sh
+.vscode
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -107,15 +107,15 @@ To run these:
 
 The documentation is created using Sphinx.
 To locally build the documentation, run the following:
-
+ 
 ```bash
-sphinx-build docs docs/_build
+sphinx-build -a docs docs/_build
 ```
 
 The documentation can then be viewed at `docs/_build/index.html`
 
 
-### Creating a new release
+## Creating a new release
 
 Releases are created manually from the main branch via tags.
 This should be done via the GitHub web interface.
-Original file line number
+Diff line change
@@ Expand Up / @@ -107,3 +107,4 @@ setup_env.sh @@
     # mypy
     .mypy_cache/
     bin/setup_local_env.sh
+    .vscode