Merge pull request #83 from Stravaig-Projects/#62-docs

#62 Create "Read the Docs" documentation

Author: colinangusmackay

.gitignore

@@ -4,6 +4,7 @@
 ## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore
 
 docs/build/
+docs/_build/
 docs/source/_build
 
 # User-specific files

.readthedocs.yml

@@ -0,0 +1,26 @@
+# .readthedocs.yml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+  builder: html
+  fail_on_warning: true
+
+# Build documentation with MkDocs
+#mkdocs:
+#  configuration: mkdocs.yml
+
+# Optionally build your docs in additional formats such as PDF
+# formats:
+#   - pdf
+
+# Optionally set the version of Python and requirements required to build your docs
+# python:
+#   version: 3.7
+#   install:
+#     - requirements: docs/requirements.txt

.vscode/settings.json

@@ -6,5 +6,6 @@
         "nunit",
         "nupkg",
         "snupkg"
-    ]
+    ],
+    "restructuredtext.confPath": "${workspaceFolder}\\docs"
 }

Example/.idea/.idea.Example/.idea/.gitignore

@@ -0,0 +1,30 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using Microsoft.AspNetCore.Mvc;
+
+namespace Example.Controllers
+{
+    [ApiController]
+    [Route("[controller]")]
+    public class WeatherForecastController : ControllerBase
+    {
+        private static readonly string[] Summaries = new[]
+        {
+            "Freezing", "Bracing", "Chilly", "Cool", "Mild", "Warm", "Balmy", "Hot", "Sweltering", "Scorching"
+        };
+
+        [HttpGet]
+        public IEnumerable<WeatherForecast> Get()
+        {
+            var rng = new Random();
+            return Enumerable.Range(1, 5).Select(index => new WeatherForecast
+                {
+                    Date = DateTime.Now.AddDays(index),
+                    TemperatureC = rng.Next(-20, 55),
+                    Summary = Summaries[rng.Next(Summaries.Length)]
+                })
+                .ToArray();
+        }
+    }
+}

Example/.idea/.idea.Example/.idea/indexLayout.xml

@@ -0,0 +1,16 @@
+<Project Sdk="Microsoft.NET.Sdk.Web">
+
+    <PropertyGroup>
+        <TargetFramework>net5.0</TargetFramework>
+        <UserSecretsId>5a1a71a3-bb52-41d2-8656-db4e35ab8e2a</UserSecretsId>
+  </PropertyGroup>
+
+    <ItemGroup>
+        <PackageReference Include="Microsoft.AspNetCore.Authentication.JwtBearer" Version="5.0.1" NoWarn="NU1605" />
+        <PackageReference Include="Microsoft.AspNetCore.Authentication.OpenIdConnect" Version="5.0.1" NoWarn="NU1605" />
+        <PackageReference Include="Seq.Extensions.Logging" Version="6.0.0" />
+        <PackageReference Include="Stravaig.Extensions.Configuration.Diagnostics" Version="0.5.0-preview.153" />
+        <PackageReference Include="Swashbuckle.AspNetCore" Version="5.6.3" />
+    </ItemGroup>
+
+</Project>

Example/.idea/.idea.Example/.idea/riderModule.iml

@@ -0,0 +1,16 @@
+
+Microsoft Visual Studio Solution File, Format Version 12.00
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Example", "Example.csproj", "{A8BBC55D-0E1F-4444-830E-0366D8DCCD8A}"
+EndProject
+Global
+	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+		Debug|Any CPU = Debug|Any CPU
+		Release|Any CPU = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		{A8BBC55D-0E1F-4444-830E-0366D8DCCD8A}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{A8BBC55D-0E1F-4444-830E-0366D8DCCD8A}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{A8BBC55D-0E1F-4444-830E-0366D8DCCD8A}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{A8BBC55D-0E1F-4444-830E-0366D8DCCD8A}.Release|Any CPU.Build.0 = Release|Any CPU
+	EndGlobalSection
+EndGlobal