From 733b89be12f2350aed1d181f051d27b9cb6db68f Mon Sep 17 00:00:00 2001 From: Dion Moult Date: Sun, 23 Oct 2022 12:15:00 +1100 Subject: [PATCH] Link to C++ API reference from Python Sphinx docs --- src/ifcopenshell-python/docs/conf.py | 3 +++ src/ifcopenshell-python/docs/index.rst | 2 ++ 2 files changed, 5 insertions(+) diff --git a/src/ifcopenshell-python/docs/conf.py b/src/ifcopenshell-python/docs/conf.py index ef496e66a0..db8e69524a 100644 --- a/src/ifcopenshell-python/docs/conf.py +++ b/src/ifcopenshell-python/docs/conf.py @@ -56,6 +56,9 @@ release = "0.7.0" # - I couldn't customise the template to show submodules above members which makes API discovery hard for users extensions = ["autoapi.extension"] +# We'll add the toctree entry ourselves to distinguish between C++ and Python +autoapi_add_toctree_entry = True + # We're only documenting Python here autoapi_type = 'python' diff --git a/src/ifcopenshell-python/docs/index.rst b/src/ifcopenshell-python/docs/index.rst index 471fe7d047..0d3be6b407 100644 --- a/src/ifcopenshell-python/docs/index.rst +++ b/src/ifcopenshell-python/docs/index.rst @@ -23,6 +23,8 @@ IfcOpenShell is a suite of developer libraries and utilities to manipulate OpenB ifcmax ifcsverchok bimserver-plugin + C++ API Reference + Python API Reference Indices and tables