diff --git a/src/ifcblenderexport/docs/Makefile b/src/ifcblenderexport/docs/Makefile new file mode 100644 index 0000000000..d4bb2cbb9e --- /dev/null +++ b/src/ifcblenderexport/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = . +BUILDDIR = _build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) diff --git a/src/ifcblenderexport/docs/conf.py b/src/ifcblenderexport/docs/conf.py new file mode 100644 index 0000000000..4ebda3bd2b --- /dev/null +++ b/src/ifcblenderexport/docs/conf.py @@ -0,0 +1,55 @@ +# Configuration file for the Sphinx documentation builder. +# +# This file only contains a selection of the most common options. For a full +# list see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Path setup -------------------------------------------------------------- + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +# import os +# import sys +# sys.path.insert(0, os.path.abspath('.')) + + +# -- Project information ----------------------------------------------------- + +project = 'BlenderBIM' +copyright = '2020, Dion Moult' +author = 'Dion Moult' + +# The full version, including alpha/beta/rc tags +release = '0.0.1' + + +# -- General configuration --------------------------------------------------- + +# Add any Sphinx extension module names here, as strings. They can be +# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom +# ones. +extensions = [ +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + + +# -- Options for HTML output ------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'nature' + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] diff --git a/src/ifcblenderexport/docs/index.rst b/src/ifcblenderexport/docs/index.rst new file mode 100644 index 0000000000..d4dba5110a --- /dev/null +++ b/src/ifcblenderexport/docs/index.rst @@ -0,0 +1,21 @@ +.. 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! +====================================== + +.. toctree:: + :maxdepth: 2 + :caption: Contents: + + installation + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/src/ifcblenderexport/docs/installation.rst b/src/ifcblenderexport/docs/installation.rst new file mode 100644 index 0000000000..a84420dd89 --- /dev/null +++ b/src/ifcblenderexport/docs/installation.rst @@ -0,0 +1,88 @@ +Installation +============ + +BlenderBIM is packaged as a Blender add-on, so installation is the same as any +other Blender add-on. The full instructions for end-user installation is +available at the `Get BlenderBIM `_ +website. + +If you downloaded Blender as a ``.zip`` file without running an installer, you +will find the BlenderBIM plug-in installed in: +:: + + /path/to/blender/2.81/scripts/addons/ + +Otherwise, if you installed Blender using an installation package, the add-ons +folder depends on which operating system you use. On Linux: +:: + + ~/.config/blender/2.81/scripts/addons/ + +On Mac: +:: + + /Users/{YOUR_USER}/Library/Application Support/Blender/2.81/ + +On Windows: +:: + + C:\Users\{YOUR_USER}\AppData\Roaming\Blender Foundation\2.81\scripts\addons + +Upon installation, a series of files will be created. This is necessary as +BlenderBIM has a variety of complex dependencies. A full list is below: +:: + + blenderbim/ + ifcopenshell/ + OCC/ + pystache/ + svgwrite/ + deepdiff/ + jsonpickle/ + lib/ # Note: this only exists on MacOS and Linux + ordered_set.py + pyparsing.py + +If you are not on Windows, when BlenderBIM first launches, it will create a +bunch of library files in the ``2.81/`` folder too. This is a non-standard +location to place files, but is a hack to allow people to use precompiled builds +from Conda. + +Updating +-------- + +It is recommended to uninstall the current BlenderBIM add-on before installing +the latest version to ensure the update goes well. + +From Source +----------- + +It is possible to run the latest bleeding edge version of BlenderBIM without +having to wait for an official release, since BlenderBIM is coded in Python and +doesn't require any compilation. First, install the latest official release, and +then `download the latest source code +`_. If you know +how to use Git, you can also stay up to date like so: +:: + + $ git clone https://github.com/IfcOpenShell/IfcOpenShell.git + $ cd IfcOpenShell + $ git checkout v0.6.0 + +Then, just copy the files from the source code's +``src/ifcblenderexport/blenderbim/`` folder and replace the files in your +Blender add-on's ``blenderbim/`` folder. + +Restart Blender for the changes to take effect. In ``Edit > Preferences > +Add-ons`` you will see that the version number of BlenderBIM has changed to +``0.0.999999``, which represents an un-versioned BlenderBIM. + +Uninstalling +------------ + +You can remove all of the files added by BlenderBIM in the Blender add-ons +folder and then remove the add-on using the Blender interface through ``Edit > +Preferences > Add-ons`` just like any other add-on. + +If you are not on Windows, then ensure that all library files are deleted in the +``2.81/`` directory. Do not delete any of Blender's own folders. diff --git a/src/ifcblenderexport/docs/make.bat b/src/ifcblenderexport/docs/make.bat new file mode 100644 index 0000000000..922152e96a --- /dev/null +++ b/src/ifcblenderexport/docs/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=. +set BUILDDIR=_build + +if "%1" == "" goto help + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd