WIP: testin sphinx build + artifacts x12

Author: 9and3

doc/conf.py

@@ -46,6 +46,11 @@
 sys.path.insert(0, extra_dll_dir_doc)
 sys.path.insert(0, extra_dll_dir_pysource)
 try:
+    # check general pacakae import
+    import diffCheck
+    print(f"diffCheck's version: {diffCheck.__version__}")
+
+    # check bindings
     import diffCheck.diffcheck_bindings as dfb
 except ImportError as e:
     print(f"Failed to import diffcheck_bindings: {e}")

doc/documentation.md

@@ -1,4 +1,13 @@
 (doc_guide)=
 # Documentation
 
-/// from CONTRIBUTING how to write documentation
+In DF we use `Sphinx` to generate the documentation. The documentation is written in `reStructuredText` and `Markdown` and the source files are located in the `doc` folder. The documentation is hosted on `ReadTheDocs` and is automatically updated when a new commit is pushed to the `main` branch.
+
+Documentation is autogenerated for:
+
+- [GHComponents](gh_components.rst) for the  DF Grasshopper plug-in
+- [Python API](diffCheck_PythonAPI) for the DF Python API
+
+
+```{note}
+If you need to add a new page to the documentation (e.g. a [new tutorial](tutorials.rst)), you can do so by adding a new `.rst` file in the `doc` folder and linking it in the `index.rst` file.