diff --git a/src/ifcblenderexport/docs/conf.py b/src/ifcblenderexport/docs/conf.py index b863180de3..8261480b75 100644 --- a/src/ifcblenderexport/docs/conf.py +++ b/src/ifcblenderexport/docs/conf.py @@ -31,6 +31,7 @@ release = '0.0.1' # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ + 'sphinx.ext.autodoc' ] # Add any paths that contain templates here, relative to this directory. diff --git a/src/ifcblenderexport/docs/ifcopenshell-python.rst b/src/ifcblenderexport/docs/ifcopenshell-python.rst index 5fe86f8240..1f661a3488 100644 --- a/src/ifcblenderexport/docs/ifcopenshell-python.rst +++ b/src/ifcblenderexport/docs/ifcopenshell-python.rst @@ -8,6 +8,9 @@ this document. :maxdepth: 1 :caption: Contents: + ifcopenshell-python/quickstart + ifcopenshell-python/api-documentation + Indices and tables ------------------ diff --git a/src/ifcblenderexport/docs/ifcopenshell-python/api-documentation.rst b/src/ifcblenderexport/docs/ifcopenshell-python/api-documentation.rst new file mode 100644 index 0000000000..feabcc8345 --- /dev/null +++ b/src/ifcblenderexport/docs/ifcopenshell-python/api-documentation.rst @@ -0,0 +1,18 @@ +API Documentation +================= + +.. automodule:: ifcopenshell.entity_instance + :members: + +.. automodule:: ifcopenshell.file + :members: + +.. automodule:: ifcopenshell.guid + :members: + + +.. automodule:: ifcopenshell.template + :members: + +.. automodule:: ifcopenshell.validate + :members: diff --git a/src/ifcblenderexport/docs/ifcopenshell-python/quickstart.rst b/src/ifcblenderexport/docs/ifcopenshell-python/quickstart.rst new file mode 100644 index 0000000000..56c3ce6e60 --- /dev/null +++ b/src/ifcblenderexport/docs/ifcopenshell-python/quickstart.rst @@ -0,0 +1,5 @@ +Quickstart +========== + +For starters, you can read `Using IfcOpenShell to parse IFC files with Python +`_