mirror of
https://github.com/IfcOpenShell/IfcOpenShell.git
synced 2026-08-28 15:53:00 +00:00
Rename misleading "ifcblenderexport" directory to "blenderbim"
This commit is contained in:
Dion Moult
@@ -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)
|
||||
@@ -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`
|
||||
@@ -0,0 +1,16 @@
|
||||
BIMTester
|
||||
=========
|
||||
|
||||
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`
|
||||
@@ -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`
|
||||
@@ -0,0 +1,91 @@
|
||||
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 <https://blenderbim.org/download.html>`_
|
||||
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.
|
||||
|
||||
If you receive an error when enabling the add-on, you may have installed the
|
||||
package for the wrong platform.
|
||||
|
||||
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
|
||||
<https://github.com/IfcOpenShell/IfcOpenShell/archive/v0.6.0.zip>`_. 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.
|
||||
@@ -0,0 +1,181 @@
|
||||
Scene Properties
|
||||
================
|
||||
|
||||
The scene properties panels allow you to manage data that applies to your entire
|
||||
IFC project as a whole, or to multiple elements.
|
||||
|
||||
Building Information Modeling Panel
|
||||
-----------------------------------
|
||||
|
||||
System Setup
|
||||
^^^^^^^^^^^^
|
||||
|
||||
* **Quick Project Setup** - this will create a basic spatial tree. It will
|
||||
create a tree of collections with the structure ``IfcProject > IfcSite >
|
||||
IfcBuilding > IfcStorey`` This is merely for convenience instead of having to
|
||||
create it all by yourself, since all IFC exports require a valid spatial
|
||||
tree. You can see the tree of collections in the outliner when this is done.
|
||||
* **Schema Directory** - this folder stores the current IFC schema. You can
|
||||
download different schemas from the buildingSMART website. Unless you are an
|
||||
IFC guru, you probably shouldn't touch this. BlenderBIM recognises different
|
||||
IFC data based on what is provided in this schema folder. It defaults to the
|
||||
``{{BLENDER_ADDONS_DIR}}/blenderbim/schema/`` folder, which is prepackaged
|
||||
with the IFC4 schema. This is known as the ``{SCHEMA_DIR}``.
|
||||
* **Data Directory** - the data directory holds the auxiliary data related to
|
||||
your IFC model. Examples include related property definitions, documents, and
|
||||
classification systems. Each project should have its own data directory. It
|
||||
defaults to the data directory in the
|
||||
``{{BLENDER_ADDONS_DIR}}/blenderbim/data/`` folder, which comes with some
|
||||
example preset data. You are encouraged to copy this template and set your
|
||||
own. This is known as the ``{DATA_DIR}``.
|
||||
|
||||
Software Identity
|
||||
^^^^^^^^^^^^^^^^^
|
||||
|
||||
* **GlobalId** - this field let's you enter an IFC element's ``GlobalId``. It
|
||||
must be in the 22-character encoded form.
|
||||
* **Select GlobalId** - this will select an element that has the same
|
||||
``GlobalId`` attribute as what you have specified, based on what is currently
|
||||
visible in the scene.
|
||||
|
||||
IFC Categorisation
|
||||
^^^^^^^^^^^^^^^^^^
|
||||
|
||||
* **IFC Class** - this dropdown lets you pick from a list of all non-abstract
|
||||
children of ``IfcElement`` and ``IfcSpatialStructureElement``
|
||||
* **IFC Predefined Type** - this dropdown lets you pick from an enumeration of
|
||||
valid ``PredefinedType`` values for the currently selected *IFC Class*. It
|
||||
changes dynamically with the currently selected *IFC Class*.
|
||||
* **IFC Userdefined Type** - this field lets you enter a value for a user
|
||||
defined type. It is stored as the ``ObjectType`` attribute of an
|
||||
``IfcProduct``. It is only set when the **IFC Predefined Type** is set to
|
||||
``USERDEFINED``, otherwise it is ignored. It is recommended to make this
|
||||
value uppercase and alphabetic, to match the conventions for the
|
||||
``PredefinedType`` enumeration.
|
||||
* **Assign Class** - this applies the active *IFC Class*, *IFC Predefined Type*
|
||||
and *IFC Userdefined Type* to any selected objects.
|
||||
* **Select Class** - this will select any objects that are currently visible
|
||||
that also have the same IFC class as the currently active *IFC Class*
|
||||
dropdown.
|
||||
* **Select Type** - same as *Select Class*, but it also filters by the
|
||||
currently active *IFC Predefined Type* dropdown, as well as the *IFC
|
||||
Userdefined Type* field.
|
||||
|
||||
Property Sets
|
||||
^^^^^^^^^^^^^
|
||||
|
||||
- **Pset Name** - this lets you select from a list of available property set
|
||||
types. The list is derived from the folders in
|
||||
``{DATA_DIR}/pset``. Each folder name corresponds to a property set name. If
|
||||
you want to assign properties to an object based on an IFC standard pset,
|
||||
just create a new folder with the same name as the pset. You can also create
|
||||
your own custom property sets, so long as the folder name does not start with
|
||||
``Pset_``, as these are reserved for official IFC property sets.
|
||||
- **Pset File** - this lets you select from a list of available property set
|
||||
data. The available property sets depends on the currently selected *PSet
|
||||
Name* dropdown. Each property set is represented by a ``.csv`` file inside
|
||||
``{DATA_DIR}/pset/{PSET_NAME}/``. You can create your own ``.csv`` files
|
||||
with any software, where each line contains a property name and property
|
||||
value pair. Data types are automatically converted based on the property set
|
||||
templates defined in ``{SCHEMA_DIR}``. If the pset is part of an official IFC
|
||||
standard, you can only use property names that are part of the IFC standard.
|
||||
If you want to add your own custom properties, you will need to create your
|
||||
own *PSet Name* folder first, and then you can put in your own ``.csv`` file
|
||||
which contains any property names and values that you want.
|
||||
- **Assign Pset** - this assigns the currently selected *Pset file* to any
|
||||
selected objects. The assigned data will then be visible in the *Object
|
||||
Properties*. This only assigns a link to the ``.csv`` containing the data, so
|
||||
you can change the data in the ``.csv`` file and that will automatically
|
||||
propagate to all assigned elements when an IFC is exported, without needing
|
||||
to reassign the data.
|
||||
- **Unassign Pset** - this removes the link to the property set ``.csv``
|
||||
file for all currently selected objects.
|
||||
|
||||
Aggregates
|
||||
^^^^^^^^^^
|
||||
|
||||
- **Aggregate Class** - this lets you select what type of class you want an
|
||||
aggregate of parts to be.
|
||||
- **Aggregate name** - this lets you set the name of an aggregate that you can
|
||||
can create.
|
||||
- **Create Aggregate** - this will create a new aggregate from one or more
|
||||
currently selected objects. The selected objects will be moved out of the
|
||||
spatial tree into an ``IfcRelAggregates/*`` collection. Then, a collection
|
||||
instance will be created to represent the aggregation, and will be placed in
|
||||
the current location of the spatial tree, and the The parts will then be
|
||||
hidden so only the whole composition (i.e. the aggregate object) will be
|
||||
shown.
|
||||
- **Explode Aggregate** - this does the opposite of *Create Aggregate*, and
|
||||
will remove the aggregation.
|
||||
- **Edit Aggregate** - this will hide the collection instance that represents
|
||||
the aggregate object, and show all of the individual parts. This allows you
|
||||
to select and modify the aggregate parts.
|
||||
- **Save Aggregate** - this does the opposite of *Edit Aggregate*.
|
||||
|
||||
IFC Classifications Panel
|
||||
-------------------------
|
||||
|
||||
- **Classification** - this lets you select which classification system you'd
|
||||
like to use. The list of possible classification systems is derived from the
|
||||
``{DATA_DIR}/class/classifications.csv`` file. By default, BlenderBIM comes
|
||||
with Uniclass 2015 and Omniclass. If you need another classification system,
|
||||
you can add it to this ``.csv`` file.
|
||||
- **Reference** - this lets you select a single classification reference item,
|
||||
filtered depending on the currently active *Classification*. The list is
|
||||
derived from the ``{DATA_DIR}/class/references.csv`` file. Out of the box,
|
||||
BlenderBIM only lists a single Uniclass reference as an example. It is
|
||||
advised to make a list of all the references you require for a project and
|
||||
add it to this ``.csv`` file.
|
||||
- **Assign Classification** - this assigns the currently active *Reference* to
|
||||
all of the selected objects. You can see the results in the *Object
|
||||
Properties* pane.
|
||||
- **Unassign Classification** - this removes the currently active *Reference*
|
||||
in all of the selected objects.
|
||||
|
||||
IFC Owner History Panel
|
||||
-----------------------
|
||||
|
||||
- **Person** - this lets you select who you are. The values are derived from
|
||||
the ``{DATA_DIR}/owner/person.json`` file, particularly the
|
||||
``Identification`` attribute, which is mandatory and a requirement in COBie
|
||||
data. You are encouraged to edit this file to add your own details. This
|
||||
information will be stored in the IFC file as part of the owner history to
|
||||
keep track of any objects which you edit. You will also be recorded as the
|
||||
author of the IFC file.
|
||||
- **Organisation** - this lets you select which organisation you are part of.
|
||||
The values are derived from the ``{DATA_DIR}/owner/organisation.json`` file,
|
||||
in particular the ``Name`` attribute, which is mandatory and a requirement in
|
||||
COBie data. You are encouraged to edit this file to add your own organisation
|
||||
details. This information will be stored in the IFC file as part of the
|
||||
owner history to keep track of any objects which you edit. The organisation
|
||||
will also be recorded as the author of the IFC file.
|
||||
|
||||
|
||||
IFC Geometric Representation Contexts Panel
|
||||
-------------------------------------------
|
||||
|
||||
- **Has Model Context** - enabling this will allow you to export geometric data
|
||||
related to the model view of your BIM data. This is generally 3D
|
||||
representations. It may also contain wireframe representations such as an
|
||||
Axis model for structural members. This defaults to being enabled, as most
|
||||
people want to export model geometry.
|
||||
|
||||
- **Available Subcontexts** - this lets you select a possible subcontext to
|
||||
be used underneath the Model context.
|
||||
- **Available Target Views** - subcontexts may have a particular target view,
|
||||
which you can set here.
|
||||
- **Add Subcontext** - This will add a new subcontext based on the currently
|
||||
selected *Available Subcontext* and *Available Target View*.
|
||||
|
||||
- **Subcontext Name** - for each subcontext you have added, it will show
|
||||
you the subcontext name. By default, the ``Body`` subcontext is added,
|
||||
as most people want to export the body geometry of products in their BIM
|
||||
data.
|
||||
- **Subcontext Target View** - same as *Subcontext Name*, but shows the
|
||||
target view. By default, the ``MODEL_VIEW`` target view is added, as most
|
||||
people will be viewing the model geometry of your BIM data.
|
||||
- **Remove Subcontext** - this will remove the subcontext.
|
||||
|
||||
- **Has Plan Context** - the same as *Has Model Context*, but it lets you add
|
||||
subcontexts and target views related to the ``PLAN`` context of your BIM
|
||||
data. This is usually plans, sections, RCPs, and other documentation views.
|
||||
@@ -0,0 +1,54 @@
|
||||
# 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 = "IfcOpenShell"
|
||||
copyright = "2020, IfcOpenShell Contributors"
|
||||
author = "IfcOpenShell Contributors"
|
||||
|
||||
# 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 = ["sphinx.ext.autodoc"]
|
||||
|
||||
# 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"]
|
||||
@@ -0,0 +1,16 @@
|
||||
IfcClash
|
||||
========
|
||||
|
||||
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`
|
||||
@@ -0,0 +1,16 @@
|
||||
IfcCOBie
|
||||
========
|
||||
|
||||
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`
|
||||
@@ -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`
|
||||
@@ -0,0 +1,16 @@
|
||||
IfcDiff
|
||||
=======
|
||||
|
||||
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`
|
||||
@@ -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`
|
||||
@@ -0,0 +1,19 @@
|
||||
IfcOpenShell-Python
|
||||
===================
|
||||
|
||||
This documentation is free software! You are free to contribute and help write
|
||||
this document.
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:caption: Contents:
|
||||
|
||||
ifcopenshell-python/quickstart
|
||||
ifcopenshell-python/api-documentation
|
||||
|
||||
Indices and tables
|
||||
------------------
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
@@ -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:
|
||||
@@ -0,0 +1,5 @@
|
||||
Quickstart
|
||||
==========
|
||||
|
||||
For starters, you can read `Using IfcOpenShell to parse IFC files with Python
|
||||
<https://thinkmoult.com/using-ifcopenshell-parse-ifc-files-python.html>`_
|
||||
@@ -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`
|
||||
@@ -0,0 +1,25 @@
|
||||
IfcOpenShell Documentation
|
||||
==========================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:caption: Contents:
|
||||
|
||||
ifcopenshell
|
||||
ifcopenshell-python
|
||||
ifcconvert
|
||||
blenderbim
|
||||
bimtester
|
||||
ifcdiff
|
||||
ifcclash
|
||||
ifccobie
|
||||
ifcmax
|
||||
bimserver-plugin
|
||||
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
@@ -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
|
||||
Reference in New Issue
Block a user