Integrate sphinx to read .xml documentation from Visual Studio

.gitignore

@@ -4,6 +4,7 @@ crest/[Oo]bj/
 crest/[Bb]uild/
 crest/[Bb]uilds/
 crest/[Ll]ogs/
+crest/[Pp]ackages/*/
 crest/Assets/AssetStoreTools*
 
 # Visual Studio 2015 cache directory

crest/packages.config

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="utf-8"?>
+<packages>
+  <package id="Vsxmd" version="1.4.5" targetFramework="net471" developmentDependency="true" />
+</packages>

docs/.gitignore

@@ -132,6 +132,9 @@ pythonenv*
 # Rope project settings
 .ropeproject
 
+# Visual Studio Code project settings
+.vscode
+
 # mkdocs documentation
 /site
 

docs/conf.py

@@ -12,6 +12,7 @@
 
 import os
 import sys
+
 sys.path.insert(0, os.path.abspath('./extensions'))
 
 # -- Project information -----------------------------------------------------
@@ -20,6 +21,37 @@
 copyright = '2021, Wave Harmonic & Contributors'
 author = 'Wave Harmonic & Contributors'
 
+# -- Create API copy DefaultDocumentation  -----------------------------------
+
+import subprocess
+
+if not (os.path.exists('api/') and os.path.isdir('api/')):
+    os.mkdir('api/')
+
+try:
+    vswhere_cmd = subprocess.run(['vswhere', '-latest', '-requires', 'Microsoft.Component.MSBuild', '-find', 'MSBuild\\**\\Bin\\MsBuild.exe'], check=True, stdout=subprocess.PIPE)
+    msbuild_path = vswhere_cmd.stdout.strip()
+    csproj_path = os.path.abspath('../crest/Crest.csproj')
+    xml_path = os.path.abspath('./api/api.xml')
+    print(xml_path)
+
+    msbuild_cmd = subprocess.run([msbuild_path, '-p:DocumentationFile=' + xml_path, csproj_path], stdout=subprocess.DEVNULL)
+except:
+    print("Unable to build API from source. Continuing...")
+# try:
+#     files = [file for file in os.listdir("../crest/Temp/bin/Debug") if file.endswith('.md')]
+#     if not (os.path.exists('api/') and os.path.isdir('api/')):
+#         os.mkdir('api/')
+#     if len(files) == 0:
+#         raise FileNotFoundError("No .md files were found in ../crest/Temp/bin/Debug/")
+
+#     import shutil
+#     for file_name in files:
+#         shutil.copyfile(os.path.abspath('../crest/Temp/bin/Debug/' + file_name), os.path.abspath('api/' + file_name))
+# except FileNotFoundError as e:
+#     print(e)
+#     print('Assuming .md files are already present in docs/api/')
+
 
 # -- General configuration ---------------------------------------------------
 
@@ -34,6 +66,9 @@
 
     "furo",
 
+    "recommonmark",
+    "sphinx_markdown_tables",
+
     # Local packages
     "youtube",
     "variables",
@@ -45,6 +80,11 @@
     "sphinx_search.extension",
 ]
 
+source_suffix = {
+    '.rst': 'restructuredtext',
+    '.md': 'markdown',
+}
+
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 

docs/index.rst

@@ -112,6 +112,7 @@ User Guide
    user/performance
    user/technical-information
    user/faq
+   api/Crest
 
 .. user/quickstart
 .. user/support

docs/requirements.txt

@@ -15,6 +15,7 @@ Pygments==2.8.0
 pyparsing==2.4.7
 pytz==2021.1
 readthedocs-sphinx-search==0.1.0
+recommonmark==0.7.1
 requests==2.25.1
 six==1.15.0
 snowballstemmer==2.1.0
@@ -24,6 +25,7 @@ sphinx-autobuild==2020.9.1
 sphinx-hoverxref==0.5b1
 sphinx-inline-tabs @ git+https://github.com/daleeidd/sphinx-inline-tabs@e70a7d08f11df10df1011c575d73d6f296b62cfc
 sphinx-issues==1.2.0
+sphinx-markdown-tables==0.0.15
 sphinx-panels==0.5.2
 sphinxcontrib-applehelp==1.0.2
 sphinxcontrib-devhelp==1.0.2