Glassvision/IfcOpenShell
1
0
Fork 0
mirror of https://github.com/IfcOpenShell/IfcOpenShell.git synced 2026-08-11 02:02:22 +00:00
Code Issues Packages Projects Releases Wiki Activity

Upload files to generate documentation

Browse Source
This commit is contained in:
johltn
2020-10-25 12:17:21 +01:00
parent 5ed0b4d972
commit 1f76f73aa6
3 changed files with 6 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/CMakeLists.txt
+5 -38
View File
@@ -7,55 +7,22 @@ set(SPHINX_BUILD ${CMAKE_CURRENT_BINARY_DIR}/docs/sphinx)
MESSAGE(STATUS "SPHINX BUILD ${CMAKE_CURRENT_BINARY_DIR}")
file(MAKE_DIRECTORY ./output/doxygen)
set(OUTPUT_FOLDER ./output)
if (DOXYGEN_FOUND)
MESSAGE(STATUS "${PROJECT_SOURCE_DIR}")
MESSAGE(STATUS "${DOXYGEN_OUTPUT_DIR}/html/index.html")
# # Find all the public headers
# #get_target_property(IFC_GEOM_PUBLIC_HEADER_DIR IfcGeom INTERFACE_INCLUDE_DIRECTORIES)
# file(GLOB_RECURSE CAT_CUTIFIER_PUBLIC_HEADERS ${CAT_CUTIFIER_PUBLIC_HEADER_DIR}/*.h)
# file(GLOB SERIALIZERS_H_FILES C://Users//jlutt//Documents//IfcOpenShell//src//testdoc/*.h)
# set(DOXYGEN_INPUT_DIR C://Users//jlutt//Documents//IfcOpenShell//src//testdoc)
# file(GLOB SERIALIZERS_H_FILES C://Users//jlutt//Documents//IfcOpenShell//src//serializers/*.h)
# set(DOXYGEN_OUTPUT_DIR C://Users//jlutt//Documents//IfcOpenShell//docs/doxygen)
# set(DOXYGEN_INDEX_FILE C://Users//jlutt//Documents//IfcOpenShell//docs/doxygen/html/index.html)
# set(DOXYFILE_IN C://Users//jlutt//Documents//IfcOpenShell//docs//Doxyfile.in)
# set(DOXYFILE_OUT C://Users//jlutt//Documents//IfcOpenShell//docs//Doxyfile.out)
# #Replace variables inside @@ with the current values
# configure_file(${DOXYFILE_IN} ${DOXYFILE_OUT} @ONLY)
add_custom_target(Sphinx ALL
COMMAND
${SPHINX_EXECUTABLE} -b html
${SPHINX_SOURCE} C://Users//jlutt//Documents//IfcOpenShell//docs//output//sphinx
WORKING_DIRECTORY C://Users//jlutt//Documents//IfcOpenShell//docs//output
#WORKING_DIRECTORY ${OUTPUT_FOLDER}
${SPHINX_SOURCE} ${CMAKE_CURRENT_SOURCE_DIR}/output
WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/output
COMMENT "Generating documentation with Sphinx")
add_custom_target(pyrealsense2_docs ALL
add_custom_target(ifcopenshell_python_docs ALL
COMMAND make html
WORKING_DIRECTORY C://Users//jlutt//Documents//IfcOpenShell//src//ifcblenderexport//docs
OUTPUT C://Users//jlutt//Documents//IfcOpenShell//src//ifcblenderexport//docs
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/conf.py
+1 -1
View File
@@ -31,7 +31,7 @@ exhale_args = {
# TIP: if using the sphinx-bootstrap-theme, you need
# "treeViewIsBootstrap": True,
"exhaleExecutesDoxygen": True,
"exhaleDoxygenStdin": "INPUT = ../src/testdoc ../src/ifcconvert"
"exhaleDoxygenStdin": "INPUT = ../src/serializers ../src/ifcconvert"
}
# html_theme = 'sphinx_rtd_theme'
docs/index.rst
-9
View File
@@ -1,14 +1,5 @@
.. ifcgeom documentation master file, created by
sphinx-quickstart on Tue Sep 15 09:59:35 2020.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to IfcOpenShell's documentation!
========================================
.. |logo| image:: stars.jpg
:width: 20pt
:height: 20pt
.. toctree::
:maxdepth: 3