Documentation changes

This commit is contained in:
aothms
2021-02-06 15:10:41 +00:00
parent ea34c3de85
commit af6aed80da
5 changed files with 20 additions and 30 deletions
+1 -1
View File
@@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8
# title of most generated pages and in a few other places. # title of most generated pages and in a few other places.
# The default value is: My Project. # The default value is: My Project.
PROJECT_NAME = "My Project" PROJECT_NAME = "IfcOpenShell"
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
# could be handy for archiving the generated documentation or if some version # could be handy for archiving the generated documentation or if some version
+1 -12
View File
@@ -34,15 +34,4 @@ exhale_args = {
} }
cpp_id_attributes = ['IFC_PARSE_API', 'IFC_GEOM_API']
# html_theme = 'sphinx_rtd_theme'
# # Tell sphinx what the primary language being documented is.
# primary_domain = 'cpp'
# # Tell sphinx what the pygments highlight language should be.
# highlight_language = 'cpp'
+17 -6
View File
@@ -1,28 +1,39 @@
# This program requires doxygen, sphinx, breathe and exhale. # This program requires doxygen, sphinx, breathe and exhale.
import os import os
import sys
import shutil import shutil
import subprocess import subprocess
import multiprocessing
from sys import platform # 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)
conf_path = "./conf.py" # not used, -j caused issues in my sphinx install
index_path = "./index.rst" j = str(multiprocessing.cpu_count())
if not os.path.isdir("./output/doxygen/xml"): if not os.path.isdir("./output/doxygen/xml"):
os.makedirs("output/doxygen/xml") os.makedirs("output/doxygen/xml")
subprocess.check_call(["sphinx-build", "-b", "html", ".", "output"]) subprocess.check_call([sphinx_build, "-b", "html", ".", "output"])
if platform == "linux" or platform == "linux2": if sys.platform == "linux" or sys.platform == "linux2":
if os.path.isdir("output/python"): if os.path.isdir("output/python"):
shutil.rmtree("output/python") shutil.rmtree("output/python")
if not os.path.exists(os.path.join("../src/ifcblenderexport/docs", "contents.rst")): 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(["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(["make", "html"], cwd="../src/ifcblenderexport/docs")
subprocess.check_call(["git", "checkout", "conf.py"], cwd="../src/ifcblenderexport/docs"))
shutil.move("../src/ifcblenderexport/docs/_build", "./output") shutil.move("../src/ifcblenderexport/docs/_build", "./output")
os.rename("./output/_build", "./output/python") os.rename("./output/_build", "./output/python")
elif platform == "win32" or platform == "win64": elif sys.platform == "win32" or sys.platform == "win64":
subprocess.check_call(["make.bat", "html"]) subprocess.check_call(["make.bat", "html"])
+1 -1
View File
@@ -7,4 +7,4 @@ IfcOpenShell
rst_files/library_root rst_files/library_root
`ifcopenshell-python documentation <_build/html/index.html>`_ * `ifcopenshell-python documentation <python/html/index.html>`_
-10
View File
@@ -1,10 +0,0 @@
IfcOpenShell
============
.. toctree::
:maxdepth: 3
rst_files/library_root
`ifcopenshell-python documentation <_build/html/index.html>`_