From 9b5265e6fdf5b7834b19c52db3bf2ef0af1521b1 Mon Sep 17 00:00:00 2001 From: Dion Moult Date: Tue, 21 Jan 2020 17:53:05 +1100 Subject: [PATCH] Merge IfcOpenShell documentation structure. See #755. --- .../docs/bimserver-plugin.rst | 16 +++++++++++++ src/ifcblenderexport/docs/blenderbim.rst | 23 +++++++++++++++++++ .../docs/{ => blenderbim}/installation.rst | 0 .../docs/{ => blenderbim}/scene.rst | 0 src/ifcblenderexport/docs/ifcconvert.rst | 16 +++++++++++++ src/ifcblenderexport/docs/ifcmax.rst | 16 +++++++++++++ .../docs/ifcopenshell-python.rst | 16 +++++++++++++ src/ifcblenderexport/docs/ifcopenshell.rst | 16 +++++++++++++ src/ifcblenderexport/docs/index.rst | 19 ++++++++------- 9 files changed, 112 insertions(+), 10 deletions(-) create mode 100644 src/ifcblenderexport/docs/bimserver-plugin.rst create mode 100644 src/ifcblenderexport/docs/blenderbim.rst rename src/ifcblenderexport/docs/{ => blenderbim}/installation.rst (100%) rename src/ifcblenderexport/docs/{ => blenderbim}/scene.rst (100%) create mode 100644 src/ifcblenderexport/docs/ifcconvert.rst create mode 100644 src/ifcblenderexport/docs/ifcmax.rst create mode 100644 src/ifcblenderexport/docs/ifcopenshell-python.rst create mode 100644 src/ifcblenderexport/docs/ifcopenshell.rst diff --git a/src/ifcblenderexport/docs/bimserver-plugin.rst b/src/ifcblenderexport/docs/bimserver-plugin.rst new file mode 100644 index 0000000000..432c499f87 --- /dev/null +++ b/src/ifcblenderexport/docs/bimserver-plugin.rst @@ -0,0 +1,16 @@ +BIMServer-Plugin +================ + +This documentation is free software! You are free to contribute and help write +this document. + +.. toctree:: + :maxdepth: 1 + :caption: Contents: + +Indices and tables +------------------ + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/src/ifcblenderexport/docs/blenderbim.rst b/src/ifcblenderexport/docs/blenderbim.rst new file mode 100644 index 0000000000..62fbade88b --- /dev/null +++ b/src/ifcblenderexport/docs/blenderbim.rst @@ -0,0 +1,23 @@ +BlenderBIM +========== + +BlenderBIM is an add-on to Blender that turns Blender into a powerful BIM +authoring program, supporting IFC import, export, and data manipulation. + +This documentation is free software! You are free to contribute and help write +this document. + +.. toctree:: + :maxdepth: 1 + :caption: Contents: + + blenderbim/installation + blenderbim/scene + + +Indices and tables +------------------ + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/src/ifcblenderexport/docs/installation.rst b/src/ifcblenderexport/docs/blenderbim/installation.rst similarity index 100% rename from src/ifcblenderexport/docs/installation.rst rename to src/ifcblenderexport/docs/blenderbim/installation.rst diff --git a/src/ifcblenderexport/docs/scene.rst b/src/ifcblenderexport/docs/blenderbim/scene.rst similarity index 100% rename from src/ifcblenderexport/docs/scene.rst rename to src/ifcblenderexport/docs/blenderbim/scene.rst diff --git a/src/ifcblenderexport/docs/ifcconvert.rst b/src/ifcblenderexport/docs/ifcconvert.rst new file mode 100644 index 0000000000..68d3dd63bc --- /dev/null +++ b/src/ifcblenderexport/docs/ifcconvert.rst @@ -0,0 +1,16 @@ +IfcConvert +========== + +This documentation is free software! You are free to contribute and help write +this document. + +.. toctree:: + :maxdepth: 1 + :caption: Contents: + +Indices and tables +------------------ + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/src/ifcblenderexport/docs/ifcmax.rst b/src/ifcblenderexport/docs/ifcmax.rst new file mode 100644 index 0000000000..5d94a63fcc --- /dev/null +++ b/src/ifcblenderexport/docs/ifcmax.rst @@ -0,0 +1,16 @@ +IfcMax +====== + +This documentation is free software! You are free to contribute and help write +this document. + +.. toctree:: + :maxdepth: 1 + :caption: Contents: + +Indices and tables +------------------ + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/src/ifcblenderexport/docs/ifcopenshell-python.rst b/src/ifcblenderexport/docs/ifcopenshell-python.rst new file mode 100644 index 0000000000..5fe86f8240 --- /dev/null +++ b/src/ifcblenderexport/docs/ifcopenshell-python.rst @@ -0,0 +1,16 @@ +IfcOpenShell-Python +=================== + +This documentation is free software! You are free to contribute and help write +this document. + +.. toctree:: + :maxdepth: 1 + :caption: Contents: + +Indices and tables +------------------ + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/src/ifcblenderexport/docs/ifcopenshell.rst b/src/ifcblenderexport/docs/ifcopenshell.rst new file mode 100644 index 0000000000..03bc090cc1 --- /dev/null +++ b/src/ifcblenderexport/docs/ifcopenshell.rst @@ -0,0 +1,16 @@ +IfcOpenShell +============ + +This documentation is free software! You are free to contribute and help write +this document. + +.. toctree:: + :maxdepth: 1 + :caption: Contents: + +Indices and tables +------------------ + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/src/ifcblenderexport/docs/index.rst b/src/ifcblenderexport/docs/index.rst index 15dd262be9..65fc7f1f40 100644 --- a/src/ifcblenderexport/docs/index.rst +++ b/src/ifcblenderexport/docs/index.rst @@ -1,17 +1,16 @@ -.. BlenderBIM documentation master file, created by - sphinx-quickstart on Wed Jan 8 09:59:58 2020. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Welcome to BlenderBIM's documentation! -====================================== +IfcOpenShell Documentation +========================== .. toctree:: - :maxdepth: 2 + :maxdepth: 1 :caption: Contents: - installation - scene + ifcopenshell + ifcopenshell-python + ifcconvert + blenderbim + ifcmax + bimserver-plugin Indices and tables