mirror of
https://github.com/IfcOpenShell/IfcOpenShell.git
synced 2026-08-09 17:31:45 +00:00
Add autodoc for IfcOpenShell-python. See #755.
This commit is contained in:
@@ -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.
|
||||
|
||||
@@ -8,6 +8,9 @@ this document.
|
||||
:maxdepth: 1
|
||||
:caption: Contents:
|
||||
|
||||
ifcopenshell-python/quickstart
|
||||
ifcopenshell-python/api-documentation
|
||||
|
||||
Indices and tables
|
||||
------------------
|
||||
|
||||
|
||||
@@ -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>`_
|
||||
Reference in New Issue
Block a user