merge all

docs/CMakeLists.txt

@@ -0,0 +1,40 @@
+#Look for an executable called sphinx-build
+find_program(SPHINX_EXECUTABLE
+             NAMES sphinx-build
+             DOC "Path to sphinx-build executable")
+
+include(FindPackageHandleStandardArgs)
+
+#Handle standard arguments to find_package like REQUIRED and QUIET
+find_package_handle_standard_args(Sphinx
+                                  "Failed to find sphinx-build executable"
+                                  SPHINX_EXECUTABLE)
+
+find_package(Doxygen REQUIRED)
+#find_package(Sphinx REQUIRED)
+
+set(SPHINX_SOURCE ${CMAKE_CURRENT_SOURCE_DIR})
+set(SPHINX_BUILD ${CMAKE_CURRENT_BINARY_DIR}/docs/sphinx)
+
+MESSAGE(STATUS "SPHINX BUILD ${CMAKE_CURRENT_BINARY_DIR}")
+
+file(MAKE_DIRECTORY ./output/doxygen)
+
+if (DOXYGEN_FOUND)
+
+add_custom_target(Sphinx ALL
+                  COMMAND
+                  ${SPHINX_EXECUTABLE} -v -T -b html
+				  ${SPHINX_SOURCE} ${CMAKE_CURRENT_SOURCE_DIR}/output
+				  WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/output
+                  COMMENT "Generating documentation with Sphinx")
+					  
+# add_custom_target(ifcopenshell_python_docs ALL
+                  # COMMAND make html
+                  # WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/../src/ifcblenderexport/docs
+				  # OUTPUT ${CMAKE_CURRENT_SOURCE_DIR}/../src/ifcblenderexport/docs
+                  # COMMENT "Generating documentation with Sphinx")
+	
+else (DOXYGEN_FOUND)
+  message("Doxygen need to be installed to generate the doxygen documentation")
+endif (DOXYGEN_FOUND)

docs/cmake/FindSphinx.cmake

@@ -0,0 +1,11 @@
+#Look for an executable called sphinx-build
+find_program(SPHINX_EXECUTABLE
+             NAMES sphinx-build
+             DOC "Path to sphinx-build executable")
+
+include(FindPackageHandleStandardArgs)
+
+#Handle standard arguments to find_package like REQUIRED and QUIET
+find_package_handle_standard_args(Sphinx
+                                  "Failed to find sphinx-build executable"
+                                  SPHINX_EXECUTABLE)

docs/cmake/SphinxConfig.cmake

@@ -0,0 +1,11 @@
+#Look for an executable called sphinx-build
+find_program(SPHINX_EXECUTABLE
+             NAMES sphinx-build
+             DOC "Path to sphinx-build executable")
+
+include(FindPackageHandleStandardArgs)
+
+#Handle standard arguments to find_package like REQUIRED and QUIET
+find_package_handle_standard_args(Sphinx
+                                  "Failed to find sphinx-build executable"
+                                  SPHINX_EXECUTABLE)

docs/conf.py

@@ -0,0 +1,37 @@
+import textwrap
+# The `extensions` list should already be in here from `sphinx-quickstart`
+extensions = [
+    # there may be others here already, e.g. 'sphinx.ext.mathjax'
+    'breathe',
+    'exhale',
+    'sphinx.ext.intersphinx'
+]
+
+project = 'IfcOpenShell'
+copyright = '2020, IfcOpenShell'
+author = ''
+
+# Setup the breathe extension
+breathe_projects = {
+    "My Project": "./output/doxygen/xml"
+}
+breathe_default_project = "My Project"
+
+# Setup the exhale extension
+exhale_args = {
+    # These arguments are required
+    "containmentFolder":     "./rst_files",
+    "rootFileName":          "library_root.rst",
+    "rootFileTitle":         "IfcOpenShell C++",
+    "doxygenStripFromPath":  "..",
+    # Suggested optional arguments
+    "createTreeView":        True,
+    # TIP: if using the sphinx-bootstrap-theme, you need
+    # "treeViewIsBootstrap": True,
+    "exhaleExecutesDoxygen": True,
+    # "exhaleDoxygenStdin":    "INPUT = ../src/serializers/ ../src/ifcgeom",
+    "exhaleUseDoxyfile": True
+
+}
+
+cpp_id_attributes = ['IFC_PARSE_API', 'IFC_GEOM_API']

docs/contents.rst

@@ -0,0 +1,10 @@
+IfcOpenShell
+============
+
+.. toctree::
+   :maxdepth: 3
+
+   rst_files/library_root
+
+
+* `ifcopenshell-python documentation <python/html/index.html>`_

docs/generate_docs.py

@@ -0,0 +1,39 @@
+# This program requires doxygen, sphinx, breathe and exhale.
+
+import os
+import sys
+import shutil
+import subprocess
+import multiprocessing
+
+# some extra check to see if we can find sphinx in pypy bin dir
+sphinx_build = os.path.join(os.path.dirname(sys.executable), 'sphinx-build')
+if not os.path.exists(sphinx_build):
+	sphinx_build = "sphinx-build"
+# else:
+# 	os.environ['PATH'] = os.pathsep + os.path.dirname(sys.executable)
+
+# not used, -j caused issues in my sphinx install
+j = str(multiprocessing.cpu_count())
+
+if not os.path.isdir("./output/doxygen/xml"):
+	os.makedirs("output/doxygen/xml")
+
+subprocess.check_call([sphinx_build, "-b", "html", ".", "output"])
+
+if sys.platform == "linux" or sys.platform == "linux2":
+	if os.path.isdir("output/python"):
+		shutil.rmtree("output/python")
+	
+	if not os.path.exists(os.path.join("../src/ifcblenderexport/docs", "contents.rst")):
+		subprocess.check_call(["ln", "index.rst", "contents.rst"], cwd="../src/ifcblenderexport/docs")
+	
+	subprocess.check_call(["sed", "-i", "s/html_theme/# html_theme/g", "conf.py"], cwd="../src/ifcblenderexport/docs")
+	subprocess.check_call(["make", "html"], cwd="../src/ifcblenderexport/docs")
+	subprocess.check_call(["git", "checkout", "conf.py"], cwd="../src/ifcblenderexport/docs")
+	
+	shutil.move("../src/ifcblenderexport/docs/_build", "./output")
+	os.rename("./output/_build", "./output/python")
+		
+elif sys.platform == "win32" or sys.platform == "win64":
+	subprocess.check_call(["make.bat", "html"])

docs/index.rst

@@ -0,0 +1,10 @@
+IfcOpenShell
+============
+
+.. toctree::
+   :maxdepth: 3
+
+   rst_files/library_root
+
+
+* `ifcopenshell-python documentation <python/html/index.html>`_