diff --git a/.travis.yml b/.travis.yml index d1840df54..0f755fba6 100644 --- a/.travis.yml +++ b/.travis.yml @@ -15,7 +15,8 @@ addons: packages: - gcc-multilib - g++-multilib - - lib32z1 + - lib32z1+ + - lsb-core matrix: include: @@ -69,7 +70,7 @@ before_install: # download/install OCE from DLR-SC channel - conda config --add channels https://conda.anaconda.org/dlr-sc # install everything required to build the receipe - - conda install conda-build anaconda-client + - conda install conda-build=1.20 anaconda-client script: diff --git a/CMakeLists.txt b/CMakeLists.txt index 4b137f387..6aa54c684 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -22,7 +22,7 @@ set(PYTHONOCC_VERSION_MAJOR 0) set(PYTHONOCC_VERSION_MINOR 17) set(PYTHONOCC_VERSION_PATCH) # Empty for official releases, set to -dev, -rc1, etc for development releases -set(PYTHONOCC_VERSION_DEVEL -dev) +set(PYTHONOCC_VERSION_DEVEL) cmake_minimum_required(VERSION 2.6) @@ -308,8 +308,6 @@ install(FILES ${BUILD_DIR}/Visualization.py DESTINATION ${PYTHONOCC_INSTALL_DIRE install(FILES ${BUILD_DIR}/_Visualization.${EXTENSION} DESTINATION ${PYTHONOCC_INSTALL_DIRECTORY} ) endif(PYTHONOCC_WRAP_VISU) -# install GC -install(FILES ${CMAKE_CURRENT_SOURCE_DIR}/src/GarbageCollector.py DESTINATION ${PYTHONOCC_INSTALL_DIRECTORY} ) # install addons install(DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/src/addons/Display DESTINATION ${PYTHONOCC_INSTALL_DIRECTORY} ) # install LICENSE file diff --git a/NEWS b/NEWS index 8c5fc11dd..3052b2808 100644 --- a/NEWS +++ b/NEWS @@ -1,3 +1,14 @@ +============================= +Version 0.17 - Septembre 2016 + +This release requires oce-0.17.0 or oce-0.17.1 or oce-0.17.2. Prefer the latter. + +* port to oce-0.17.x + +* memory management fixes + +* New examples: AIS_ColoredShape, 2d_fillet, inertia properties, edge_color, + ========================= Version 0.16.5 - May 2016 diff --git a/README.md b/README.md index c53da2759..2e58edfde 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ -[![license](https://binstar.org/jf/pythonocc-core/badges/license.svg)](https://github.com/tpaviot/pythonocc-core/blob/master/LICENSE) -[![Build Status](https://travis-ci.org/tpaviot/pythonocc-core.png?branch=master)](https://travis-ci.org/tpaviot/pythonocc-core) +[![Travis Build Status](https://travis-ci.org/tpaviot/pythonocc-core.png?branch=master)](https://travis-ci.org/tpaviot/pythonocc-core) +[![Appveyor Build status](https://ci.appveyor.com/api/projects/status/oyeifkxtknl2tslq?svg=true)](https://ci.appveyor.com/project/tpaviot/pythonocc-core) [![Conda installer](https://anaconda.org/dlr-sc/pythonocc-core/badges/installer/conda.svg)](https://anaconda.org/dlr-sc/pythonocc-core) [![Join the chat at https://gitter.im/tpaviot/pythonocc-core](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/tpaviot/pythonocc-core?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) @@ -13,13 +13,13 @@ pythonocc is a python library whose purpose is to provide 3D modeling features. It is intended to developers who aim at developing CAD/PDM/PLM applications. -Latest release : [pythonocc-core 0.16.5 (may 2016)](https://github.com/tpaviot/pythonocc-core/releases/tag/0.16.5) +Latest release : [pythonocc-core 0.17 (september 2016)](https://github.com/tpaviot/pythonocc-core/releases/tag/0.17) How to quicky download/install binaries ? ----------------------------------------- pythonocc provides precompiled [conda packages](https://anaconda.org/DLR-SC/pythonocc-core). -This will get you up & running in minutes whether you run win32/win64/linux64/osx64: +This will get you up and running in minutes whether you run win32/win64/linux64/osx64: ```bash conda install -c https://conda.anaconda.org/dlr-sc pythonocc-core @@ -43,6 +43,8 @@ We use the following online resources: https://github.com/tpaviot/pythonocc-core/issues * Mailing list http://groups.google.com/group/pythonocc/about + * Appveyor + https://ci.appveyor.com/project/tpaviot/pythonocc-core * Travic-CI https://travis-ci.org/tpaviot/pythonocc-core * twitter @@ -55,13 +57,11 @@ The basis of pythonocc is python wrapper for the [oce C++ library / CAD kernel] (https://github.com/tpaviot/oce), aka pythonocc-core. pythonocc-core version number correspond to oce library releases its wrapping. -For example; the current pythonocc-core release, 0.16.x, requires [OCE - 0.16.x](https://github.com/tpaviot/oce/releases) release. Here, the __Major__ +For example; the current pythonocc-core release, 0.17, requires any of the [OCE + 0.17.x](https://github.com/tpaviot/oce/releases) releases. Here, the __Major__ version name of either OCE or pythonocc-core release is __0__, the __Minor__ - version is __16__ and the __Patch__ version is __x__. pythonocc-core can be - built with any OCE version that has a corresponding __Major__ and __Minor__ version - number. That is pythonocc-core 0.16.0 can be built with OCE 0.16.1 and visa - versa. + version is __17__ and the __Patch__ version is (optionally) __x__. pythonocc-core can be built with any OCE version that has a corresponding __Major__ and __Minor__ version + number. For example, pythonocc-core 0.17 can be built with OCE-0.17.1. License diff --git a/appveyor.yml b/appveyor.yml index d418c91ea..951b1ef95 100644 --- a/appveyor.yml +++ b/appveyor.yml @@ -1,4 +1,4 @@ -version: pythonocc-core-0.17.2-dev.{build} +version: pythonocc-core-0.17.{build} environment: global: diff --git a/ci/conda/fix_GeomFill_BSplineCurves_Init_method.patch b/ci/conda/fix_GeomFill_BSplineCurves_Init_method.patch new file mode 100644 index 000000000..c008ade67 --- /dev/null +++ b/ci/conda/fix_GeomFill_BSplineCurves_Init_method.patch @@ -0,0 +1,56 @@ +# Fixes related to specific dlr-sc oce patch + +diff --git src/SWIG_files/wrapper/GeomFill.i src/SWIG_files/wrapper/GeomFill.i +index bbb7c2b..32ad950 100644 +--- src/SWIG_files/wrapper/GeomFill.i ++++ src/SWIG_files/wrapper/GeomFill.i +@@ -970,48 +970,6 @@ class GeomFill_BSplineCurves { + :rtype: None + ") GeomFill_BSplineCurves; + GeomFill_BSplineCurves (const Handle_Geom_BSplineCurve & C1,const Handle_Geom_BSplineCurve & C2,const GeomFill_FillingStyle Type); +- %feature("compactdefaultargs") Init; +- %feature("autodoc", " * if the curves cannot be joined +- +- :param C1: +- :type C1: Handle_Geom_BSplineCurve & +- :param C2: +- :type C2: Handle_Geom_BSplineCurve & +- :param C3: +- :type C3: Handle_Geom_BSplineCurve & +- :param C4: +- :type C4: Handle_Geom_BSplineCurve & +- :param Type: +- :type Type: GeomFill_FillingStyle +- :rtype: None +-") Init; +- void Init (const Handle_Geom_BSplineCurve & C1,const Handle_Geom_BSplineCurve & C2,const Handle_Geom_BSplineCurve & C3,const Handle_Geom_BSplineCurve & C4,const GeomFill_FillingStyle Type); +- %feature("compactdefaultargs") Init; +- %feature("autodoc", " * if the curves cannot be joined +- +- :param C1: +- :type C1: Handle_Geom_BSplineCurve & +- :param C2: +- :type C2: Handle_Geom_BSplineCurve & +- :param C3: +- :type C3: Handle_Geom_BSplineCurve & +- :param Type: +- :type Type: GeomFill_FillingStyle +- :rtype: None +-") Init; +- void Init (const Handle_Geom_BSplineCurve & C1,const Handle_Geom_BSplineCurve & C2,const Handle_Geom_BSplineCurve & C3,const GeomFill_FillingStyle Type); +- %feature("compactdefaultargs") Init; +- %feature("autodoc", " * Initializes or reinitializes this algorithm with two, three, or four curves - C1, C2, C3, and C4 - and Type, one of the following filling styles: - GeomFill_Stretch - the style with the flattest patch - GeomFill_Coons - a rounded style of patch with less depth than that of Curved - GeomFill_Curved - the style with the most rounded patch. Exceptions Standard_ConstructionError if the curves are not contiguous. +- +- :param C1: +- :type C1: Handle_Geom_BSplineCurve & +- :param C2: +- :type C2: Handle_Geom_BSplineCurve & +- :param Type: +- :type Type: GeomFill_FillingStyle +- :rtype: None +-") Init; +- void Init (const Handle_Geom_BSplineCurve & C1,const Handle_Geom_BSplineCurve & C2,const GeomFill_FillingStyle Type); + %feature("compactdefaultargs") Surface; + %feature("autodoc", " * Returns the BSpline surface Surface resulting from the computation performed by this algorithm. + +-- diff --git a/ci/conda/meta.yaml b/ci/conda/meta.yaml index 5c51fad91..400a53b46 100644 --- a/ci/conda/meta.yaml +++ b/ci/conda/meta.yaml @@ -1,11 +1,12 @@ package: name: pythonocc-core - version: {{ environ.get('GIT_DESCRIBE_TAG', '0.17.dev') }} + version: "0.17" source: path: ../.. patches: - fix_graphicshr_location.patch [win] + - fix_GeomFill_BSplineCurves_Init_method.patch build: @@ -25,7 +26,7 @@ requirements: build: - patch [win] - python - - oce 0.17.* + - oce ==0.17.2 - cmake - ninja [win] - swig @@ -34,7 +35,7 @@ requirements: - pyqt - wxpython [py27] - pyside [py27] - - oce 0.17.* + - oce ==0.17.2 - python diff --git a/cmake/__init__.py b/cmake/__init__.py index 5d50cf6e5..391ae0852 100644 --- a/cmake/__init__.py +++ b/cmake/__init__.py @@ -1 +1 @@ -VERSION = "0.17-dev" +VERSION = "0.17" diff --git a/doc/apidoc/OCC.AppStd.rst b/doc/apidoc/OCC.AppStd.rst new file mode 100644 index 000000000..caf7d211e --- /dev/null +++ b/doc/apidoc/OCC.AppStd.rst @@ -0,0 +1,7 @@ +OCC.AppStd module +================= + +.. automodule:: OCC.AppStd + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/apidoc/OCC.AppStdL.rst b/doc/apidoc/OCC.AppStdL.rst new file mode 100644 index 000000000..0155e513e --- /dev/null +++ b/doc/apidoc/OCC.AppStdL.rst @@ -0,0 +1,7 @@ +OCC.AppStdL module +================== + +.. automodule:: OCC.AppStdL + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/apidoc/OCC.Display.backend.rst b/doc/apidoc/OCC.Display.backend.rst new file mode 100644 index 000000000..804b801a2 --- /dev/null +++ b/doc/apidoc/OCC.Display.backend.rst @@ -0,0 +1,7 @@ +OCC.Display.backend module +========================== + +.. automodule:: OCC.Display.backend + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/apidoc/OCC.Display.pyqt4Display.rst b/doc/apidoc/OCC.Display.pyqt4Display.rst deleted file mode 100644 index ede79f80c..000000000 --- a/doc/apidoc/OCC.Display.pyqt4Display.rst +++ /dev/null @@ -1,7 +0,0 @@ -OCC.Display.pyqt4Display module -=============================== - -.. automodule:: OCC.Display.pyqt4Display - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/apidoc/OCC.Display.pysideDisplay.rst b/doc/apidoc/OCC.Display.pysideDisplay.rst deleted file mode 100644 index 6b0241da0..000000000 --- a/doc/apidoc/OCC.Display.pysideDisplay.rst +++ /dev/null @@ -1,7 +0,0 @@ -OCC.Display.pysideDisplay module -================================ - -.. automodule:: OCC.Display.pysideDisplay - :members: - :undoc-members: - :show-inheritance: diff --git a/doc/apidoc/OCC.Display.qtDisplay.rst b/doc/apidoc/OCC.Display.qtDisplay.rst new file mode 100644 index 000000000..fdc0d9d00 --- /dev/null +++ b/doc/apidoc/OCC.Display.qtDisplay.rst @@ -0,0 +1,7 @@ +OCC.Display.qtDisplay module +============================ + +.. automodule:: OCC.Display.qtDisplay + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/apidoc/OCC.Display.rst b/doc/apidoc/OCC.Display.rst index ed573d952..6e57271bd 100644 --- a/doc/apidoc/OCC.Display.rst +++ b/doc/apidoc/OCC.Display.rst @@ -15,8 +15,8 @@ Submodules OCC.Display.OCCViewer OCC.Display.SimpleGui - OCC.Display.pyqt4Display - OCC.Display.pysideDisplay + OCC.Display.backend + OCC.Display.qtDisplay OCC.Display.wxDisplay Module contents diff --git a/doc/apidoc/OCC.GeomToStep.rst b/doc/apidoc/OCC.GeomToStep.rst new file mode 100644 index 000000000..a53078eed --- /dev/null +++ b/doc/apidoc/OCC.GeomToStep.rst @@ -0,0 +1,7 @@ +OCC.GeomToStep module +===================== + +.. automodule:: OCC.GeomToStep + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/apidoc/OCC.IGESCAFControl.rst b/doc/apidoc/OCC.IGESCAFControl.rst new file mode 100644 index 000000000..7f7328cf4 --- /dev/null +++ b/doc/apidoc/OCC.IGESCAFControl.rst @@ -0,0 +1,7 @@ +OCC.IGESCAFControl module +========================= + +.. automodule:: OCC.IGESCAFControl + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/apidoc/OCC.MeshVS.rst b/doc/apidoc/OCC.MeshVS.rst new file mode 100644 index 000000000..7ebe22a3f --- /dev/null +++ b/doc/apidoc/OCC.MeshVS.rst @@ -0,0 +1,7 @@ +OCC.MeshVS module +================= + +.. automodule:: OCC.MeshVS + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/apidoc/OCC.RWStepAP203.rst b/doc/apidoc/OCC.RWStepAP203.rst new file mode 100644 index 000000000..a8e98ed55 --- /dev/null +++ b/doc/apidoc/OCC.RWStepAP203.rst @@ -0,0 +1,7 @@ +OCC.RWStepAP203 module +====================== + +.. automodule:: OCC.RWStepAP203 + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/apidoc/OCC.RWStepAP214.rst b/doc/apidoc/OCC.RWStepAP214.rst new file mode 100644 index 000000000..b38981789 --- /dev/null +++ b/doc/apidoc/OCC.RWStepAP214.rst @@ -0,0 +1,7 @@ +OCC.RWStepAP214 module +====================== + +.. automodule:: OCC.RWStepAP214 + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/apidoc/OCC.RWStepBasic.rst b/doc/apidoc/OCC.RWStepBasic.rst new file mode 100644 index 000000000..4abf9601f --- /dev/null +++ b/doc/apidoc/OCC.RWStepBasic.rst @@ -0,0 +1,7 @@ +OCC.RWStepBasic module +====================== + +.. automodule:: OCC.RWStepBasic + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/apidoc/OCC.RWStepGeom.rst b/doc/apidoc/OCC.RWStepGeom.rst new file mode 100644 index 000000000..48155c58e --- /dev/null +++ b/doc/apidoc/OCC.RWStepGeom.rst @@ -0,0 +1,7 @@ +OCC.RWStepGeom module +===================== + +.. automodule:: OCC.RWStepGeom + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/apidoc/OCC.RWStepRepr.rst b/doc/apidoc/OCC.RWStepRepr.rst new file mode 100644 index 000000000..fc15d05be --- /dev/null +++ b/doc/apidoc/OCC.RWStepRepr.rst @@ -0,0 +1,7 @@ +OCC.RWStepRepr module +===================== + +.. automodule:: OCC.RWStepRepr + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/apidoc/OCC.RWStepShape.rst b/doc/apidoc/OCC.RWStepShape.rst new file mode 100644 index 000000000..f03040914 --- /dev/null +++ b/doc/apidoc/OCC.RWStepShape.rst @@ -0,0 +1,7 @@ +OCC.RWStepShape module +====================== + +.. automodule:: OCC.RWStepShape + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/apidoc/OCC.STEPCAFControl.rst b/doc/apidoc/OCC.STEPCAFControl.rst new file mode 100644 index 000000000..7e02d73d3 --- /dev/null +++ b/doc/apidoc/OCC.STEPCAFControl.rst @@ -0,0 +1,7 @@ +OCC.STEPCAFControl module +========================= + +.. automodule:: OCC.STEPCAFControl + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/apidoc/OCC.STEPConstruct.rst b/doc/apidoc/OCC.STEPConstruct.rst new file mode 100644 index 000000000..a471323d2 --- /dev/null +++ b/doc/apidoc/OCC.STEPConstruct.rst @@ -0,0 +1,7 @@ +OCC.STEPConstruct module +======================== + +.. automodule:: OCC.STEPConstruct + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/apidoc/OCC.STEPEdit.rst b/doc/apidoc/OCC.STEPEdit.rst new file mode 100644 index 000000000..6a8d27fb7 --- /dev/null +++ b/doc/apidoc/OCC.STEPEdit.rst @@ -0,0 +1,7 @@ +OCC.STEPEdit module +=================== + +.. automodule:: OCC.STEPEdit + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/apidoc/OCC.STEPSelections.rst b/doc/apidoc/OCC.STEPSelections.rst new file mode 100644 index 000000000..9c5647006 --- /dev/null +++ b/doc/apidoc/OCC.STEPSelections.rst @@ -0,0 +1,7 @@ +OCC.STEPSelections module +========================= + +.. automodule:: OCC.STEPSelections + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/apidoc/OCC.StepAP203.rst b/doc/apidoc/OCC.StepAP203.rst new file mode 100644 index 000000000..882f53064 --- /dev/null +++ b/doc/apidoc/OCC.StepAP203.rst @@ -0,0 +1,7 @@ +OCC.StepAP203 module +==================== + +.. automodule:: OCC.StepAP203 + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/apidoc/OCC.StepAP209.rst b/doc/apidoc/OCC.StepAP209.rst new file mode 100644 index 000000000..aad297aa1 --- /dev/null +++ b/doc/apidoc/OCC.StepAP209.rst @@ -0,0 +1,7 @@ +OCC.StepAP209 module +==================== + +.. automodule:: OCC.StepAP209 + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/apidoc/OCC.StepAP214.rst b/doc/apidoc/OCC.StepAP214.rst new file mode 100644 index 000000000..9a42f09a0 --- /dev/null +++ b/doc/apidoc/OCC.StepAP214.rst @@ -0,0 +1,7 @@ +OCC.StepAP214 module +==================== + +.. automodule:: OCC.StepAP214 + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/apidoc/OCC.StepBasic.rst b/doc/apidoc/OCC.StepBasic.rst new file mode 100644 index 000000000..26fc4cce3 --- /dev/null +++ b/doc/apidoc/OCC.StepBasic.rst @@ -0,0 +1,7 @@ +OCC.StepBasic module +==================== + +.. automodule:: OCC.StepBasic + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/apidoc/OCC.StepGeom.rst b/doc/apidoc/OCC.StepGeom.rst new file mode 100644 index 000000000..81c9f0c5a --- /dev/null +++ b/doc/apidoc/OCC.StepGeom.rst @@ -0,0 +1,7 @@ +OCC.StepGeom module +=================== + +.. automodule:: OCC.StepGeom + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/apidoc/OCC.StepRepr.rst b/doc/apidoc/OCC.StepRepr.rst new file mode 100644 index 000000000..93ad47e56 --- /dev/null +++ b/doc/apidoc/OCC.StepRepr.rst @@ -0,0 +1,7 @@ +OCC.StepRepr module +=================== + +.. automodule:: OCC.StepRepr + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/apidoc/OCC.StepShape.rst b/doc/apidoc/OCC.StepShape.rst new file mode 100644 index 000000000..920d2a68f --- /dev/null +++ b/doc/apidoc/OCC.StepShape.rst @@ -0,0 +1,7 @@ +OCC.StepShape module +==================== + +.. automodule:: OCC.StepShape + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/apidoc/OCC.StepToGeom.rst b/doc/apidoc/OCC.StepToGeom.rst new file mode 100644 index 000000000..010b6d75d --- /dev/null +++ b/doc/apidoc/OCC.StepToGeom.rst @@ -0,0 +1,7 @@ +OCC.StepToGeom module +===================== + +.. automodule:: OCC.StepToGeom + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/apidoc/OCC.StepToTopoDS.rst b/doc/apidoc/OCC.StepToTopoDS.rst new file mode 100644 index 000000000..0cf566707 --- /dev/null +++ b/doc/apidoc/OCC.StepToTopoDS.rst @@ -0,0 +1,7 @@ +OCC.StepToTopoDS module +======================= + +.. automodule:: OCC.StepToTopoDS + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/apidoc/OCC.TDF.rst b/doc/apidoc/OCC.TDF.rst new file mode 100644 index 000000000..e5b9e76b4 --- /dev/null +++ b/doc/apidoc/OCC.TDF.rst @@ -0,0 +1,7 @@ +OCC.TDF module +============== + +.. automodule:: OCC.TDF + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/apidoc/OCC.TDataStd.rst b/doc/apidoc/OCC.TDataStd.rst new file mode 100644 index 000000000..5d585e47c --- /dev/null +++ b/doc/apidoc/OCC.TDataStd.rst @@ -0,0 +1,7 @@ +OCC.TDataStd module +=================== + +.. automodule:: OCC.TDataStd + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/apidoc/OCC.TDataXtd.rst b/doc/apidoc/OCC.TDataXtd.rst new file mode 100644 index 000000000..9cc7dca32 --- /dev/null +++ b/doc/apidoc/OCC.TDataXtd.rst @@ -0,0 +1,7 @@ +OCC.TDataXtd module +=================== + +.. automodule:: OCC.TDataXtd + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/apidoc/OCC.TDocStd.rst b/doc/apidoc/OCC.TDocStd.rst new file mode 100644 index 000000000..397361100 --- /dev/null +++ b/doc/apidoc/OCC.TDocStd.rst @@ -0,0 +1,7 @@ +OCC.TDocStd module +================== + +.. automodule:: OCC.TDocStd + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/apidoc/OCC.TFunction.rst b/doc/apidoc/OCC.TFunction.rst new file mode 100644 index 000000000..6d1f15fcd --- /dev/null +++ b/doc/apidoc/OCC.TFunction.rst @@ -0,0 +1,7 @@ +OCC.TFunction module +==================== + +.. automodule:: OCC.TFunction + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/apidoc/OCC.TNaming.rst b/doc/apidoc/OCC.TNaming.rst new file mode 100644 index 000000000..f0cfa7ae9 --- /dev/null +++ b/doc/apidoc/OCC.TNaming.rst @@ -0,0 +1,7 @@ +OCC.TNaming module +================== + +.. automodule:: OCC.TNaming + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/apidoc/OCC.TPrsStd.rst b/doc/apidoc/OCC.TPrsStd.rst new file mode 100644 index 000000000..3ab3fec60 --- /dev/null +++ b/doc/apidoc/OCC.TPrsStd.rst @@ -0,0 +1,7 @@ +OCC.TPrsStd module +================== + +.. automodule:: OCC.TPrsStd + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/apidoc/OCC.TopoDSToStep.rst b/doc/apidoc/OCC.TopoDSToStep.rst new file mode 100644 index 000000000..a7d9aecc2 --- /dev/null +++ b/doc/apidoc/OCC.TopoDSToStep.rst @@ -0,0 +1,7 @@ +OCC.TopoDSToStep module +======================= + +.. automodule:: OCC.TopoDSToStep + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/apidoc/OCC.XCAFApp.rst b/doc/apidoc/OCC.XCAFApp.rst new file mode 100644 index 000000000..843da48a1 --- /dev/null +++ b/doc/apidoc/OCC.XCAFApp.rst @@ -0,0 +1,7 @@ +OCC.XCAFApp module +================== + +.. automodule:: OCC.XCAFApp + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/apidoc/OCC.XCAFDoc.rst b/doc/apidoc/OCC.XCAFDoc.rst new file mode 100644 index 000000000..8f6f8d24e --- /dev/null +++ b/doc/apidoc/OCC.XCAFDoc.rst @@ -0,0 +1,7 @@ +OCC.XCAFDoc module +================== + +.. automodule:: OCC.XCAFDoc + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/apidoc/OCC.XCAFPrs.rst b/doc/apidoc/OCC.XCAFPrs.rst new file mode 100644 index 000000000..f5b956458 --- /dev/null +++ b/doc/apidoc/OCC.XCAFPrs.rst @@ -0,0 +1,7 @@ +OCC.XCAFPrs module +================== + +.. automodule:: OCC.XCAFPrs + :members: + :undoc-members: + :show-inheritance: diff --git a/doc/apidoc/OCC.rst b/doc/apidoc/OCC.rst index ee32ffb8a..092f29799 100644 --- a/doc/apidoc/OCC.rst +++ b/doc/apidoc/OCC.rst @@ -16,220 +16,6 @@ Submodules OCC.AIS OCC.Adaptor2d OCC.Adaptor3d - OCC.AdvApp2Var - OCC.AdvApprox - OCC.AppBlend - OCC.AppCont - OCC.AppDef - OCC.AppParCurves - OCC.Approx - OCC.ApproxInt - OCC.Aspect - OCC.BOPAlgo - OCC.BOPCol - OCC.BOPDS - OCC.BOPInt - OCC.BOPTools - OCC.BRep - OCC.BRepAdaptor - OCC.BRepAlgo - OCC.BRepAlgoAPI - OCC.BRepApprox - OCC.BRepBlend - OCC.BRepBndLib - OCC.BRepBuilderAPI - OCC.BRepCheck - OCC.BRepClass - OCC.BRepClass3d - OCC.BRepExtrema - OCC.BRepFeat - OCC.BRepFill - OCC.BRepFilletAPI - OCC.BRepGProp - OCC.BRepIntCurveSurface - OCC.BRepLProp - OCC.BRepLib - OCC.BRepMAT2d - OCC.BRepMesh - OCC.BRepOffset - OCC.BRepOffsetAPI - OCC.BRepPrim - OCC.BRepPrimAPI - OCC.BRepProj - OCC.BRepSweep - OCC.BRepTools - OCC.BRepTopAdaptor - OCC.BSplCLib - OCC.BSplSLib - OCC.BiTgte - OCC.Bisector - OCC.Blend - OCC.BlendFunc - OCC.Bnd - OCC.BndLib - OCC.CPnts - OCC.CSLib - OCC.ChFi2d - OCC.ChFi3d - OCC.ChFiDS - OCC.ChFiKPart - OCC.Contap - OCC.Convert - OCC.Dico - OCC.Draft - OCC.DsgPrs - OCC.Dynamic - OCC.ElCLib - OCC.ElSLib - OCC.Expr - OCC.ExprIntrp - OCC.Extrema - OCC.FEmTool - OCC.FSD - OCC.FairCurve - OCC.FilletSurf - OCC.GC - OCC.GCE2d - OCC.GCPnts - OCC.GProp - OCC.GarbageCollector - OCC.GccAna - OCC.GccEnt - OCC.GccGeo - OCC.GccInt - OCC.GccIter - OCC.Geom - OCC.Geom2d - OCC.Geom2dAPI - OCC.Geom2dAdaptor - OCC.Geom2dConvert - OCC.Geom2dGcc - OCC.Geom2dHatch - OCC.Geom2dInt - OCC.Geom2dLProp - OCC.GeomAPI - OCC.GeomAbs - OCC.GeomAdaptor - OCC.GeomConvert - OCC.GeomFill - OCC.GeomInt - OCC.GeomLProp - OCC.GeomLib - OCC.GeomPlate - OCC.GeomProjLib - OCC.GeomTools - OCC.GraphDS - OCC.GraphTools - OCC.Graphic3d - OCC.HLRAlgo - OCC.HLRAppli - OCC.HLRBRep - OCC.HLRTopoBRep - OCC.Hatch - OCC.HatchGen - OCC.Hermit - OCC.IFSelect - OCC.IGESControl - OCC.Image - OCC.IncludeLibrary - OCC.IntAna - OCC.IntAna2d - OCC.IntCurve - OCC.IntCurveSurface - OCC.IntCurvesFace - OCC.IntImp - OCC.IntImpParGen - OCC.IntPatch - OCC.IntPoly - OCC.IntPolyh - OCC.IntRes2d - OCC.IntStart - OCC.IntSurf - OCC.IntTools - OCC.IntWalk - OCC.Interface - OCC.InterfaceGraphic - OCC.Intf - OCC.Intrv - OCC.LProp - OCC.LProp3d - OCC.Law - OCC.LocOpe - OCC.LocalAnalysis - OCC.MAT - OCC.MAT2d - OCC.MMgt - OCC.Materials - OCC.Message - OCC.NCollection - OCC.NLPlate - OCC.OSD - OCC.PLib - OCC.Plate - OCC.Plugin - OCC.Poly - OCC.Precision - OCC.Primitives - OCC.ProjLib - OCC.Prs3d - OCC.PrsMgr - OCC.Quantity - OCC.RWStl - OCC.Resource - OCC.STEPControl - OCC.Select3D - OCC.SelectBasics - OCC.SelectMgr - OCC.ShapeAlgo - OCC.ShapeAnalysis - OCC.ShapeBuild - OCC.ShapeConstruct - OCC.ShapeCustom - OCC.ShapeExtend - OCC.ShapeFix - OCC.ShapeProcess - OCC.ShapeProcessAPI - OCC.ShapeUpgrade - OCC.SortTools - OCC.Standard - OCC.StdFail - OCC.StdPrs - OCC.StdSelect - OCC.StlAPI - OCC.StlMesh - OCC.StlTransfer - OCC.Storage - OCC.Sweep - OCC.TColGeom - OCC.TColGeom2d - OCC.TColQuantity - OCC.TColStd - OCC.TColgp - OCC.TCollection - OCC.TShort - OCC.TopAbs - OCC.TopBas - OCC.TopClass - OCC.TopCnx - OCC.TopExp - OCC.TopLoc - OCC.TopOpeBRep - OCC.TopOpeBRepBuild - OCC.TopOpeBRepDS - OCC.TopOpeBRepTool - OCC.TopTools - OCC.TopTrans - OCC.TopoDS - OCC.Units - OCC.UnitsAPI - OCC.V3d - OCC.Visual3d - OCC.Visualization - OCC.XBRepMesh - OCC.XSControl - OCC.gce - OCC.gp - OCC.math Module contents --------------- diff --git a/doc/apidoc/conf.py b/doc/apidoc/conf.py index 3120aebb5..7a4d3f41d 100644 --- a/doc/apidoc/conf.py +++ b/doc/apidoc/conf.py @@ -14,6 +14,10 @@ import sys import os +import shlex +import sphinx +from sphinx.errors import VersionRequirementError +import sphinx_rtd_theme # 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 @@ -23,15 +27,33 @@ # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' +needs_sphinx = '1.4' +if needs_sphinx > sphinx.__display_version__: + message = 'This project needs at least Sphinx v{0!s}'.format(needs_sphinx) + raise VersionRequirementError(message) + # 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', + 'sphinx.ext.autosummary', + 'sphinx.ext.coverage', + 'sphinx.ext.graphviz', + 'sphinx.ext.doctest', + 'sphinx.ext.intersphinx', + 'sphinx.ext.todo', + 'sphinx.ext.coverage', + 'sphinx.ext.imgmath', + 'sphinx.ext.ifconfig', ] +intersphinx_mapping = {'python': ('http://docs.python.org/2', None), + 'numpy': ('http://docs.scipy.org/doc/numpy/', None), + 'scipy': ('http://docs.scipy.org/doc/scipy/reference/', None), + 'matplotlib': ('http://matplotlib.sourceforge.net/', None)} + # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -46,16 +68,20 @@ # General information about the project. project = u'pythonocc API' -copyright = u'2014, Thomas Paviot' +copyright = u'2016, Thomas Paviot' +author = u'Thomas Paviot' + +# autoclass +autoclass_content = 'both' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. -version = '0.16.0' +version = '0.17' # The full version, including alpha/beta/rc tags. -release = '0.16.0' +release = '0.17' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -79,11 +105,11 @@ #default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True +add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). -#add_module_names = True +add_module_names = False # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. @@ -96,14 +122,14 @@ #modindex_common_prefix = [] # If true, keep warnings as "system message" paragraphs in the built documents. -#keep_warnings = False +keep_warnings = False # -- 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 = 'sphinxdoc' +html_theme = "sphinx_rtd_theme" # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the @@ -111,7 +137,7 @@ #html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] +html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". @@ -158,7 +184,7 @@ #html_domain_indices = True # If false, no index is generated. -#html_use_index = True +html_use_index = True # If true, the index is split into individual pages for each letter. #html_split_index = False @@ -170,7 +196,7 @@ #html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True +html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the diff --git a/doc/apidoc/index.rst.txt b/doc/apidoc/index.rst.txt new file mode 100644 index 000000000..f8a8c4562 --- /dev/null +++ b/doc/apidoc/index.rst.txt @@ -0,0 +1,22 @@ +.. pythonocc API documentation master file, created by + sphinx-quickstart on Wed Oct 22 05:42:56 2014. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to pythonocc API's documentation! +========================================= + +Contents: + +.. toctree:: + :maxdepth: 2 + + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + diff --git a/doc/examples/conf.py b/doc/examples/conf.py index 465c80023..f6f2bad44 100644 --- a/doc/examples/conf.py +++ b/doc/examples/conf.py @@ -14,6 +14,10 @@ import sys import os +import shlex +import sphinx +from sphinx.errors import VersionRequirementError +import sphinx_rtd_theme # 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 @@ -23,12 +27,26 @@ # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' +needs_sphinx = '1.4' +if needs_sphinx > sphinx.__display_version__: + message = 'This project needs at least Sphinx v{0!s}'.format(needs_sphinx) + raise VersionRequirementError(message) # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = [] +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.autosummary', + 'sphinx.ext.coverage', + 'sphinx.ext.graphviz', + 'sphinx.ext.doctest', + 'sphinx.ext.intersphinx', + 'sphinx.ext.todo', + 'sphinx.ext.coverage', + 'sphinx.ext.imgmath', + 'sphinx.ext.ifconfig', +] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -44,20 +62,20 @@ # General information about the project. project = u'pythonocc examples' -copyright = u'2014, Thomas Paviot and others' +copyright = u'2016, Thomas Paviot' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. -version = '0.16.0' +version = '0.17' # The full version, including alpha/beta/rc tags. -release = '0.16.0' +release = '0.17' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -#language = None +language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: @@ -74,11 +92,11 @@ #default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True +add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). -#add_module_names = True +add_module_names = False # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. @@ -98,7 +116,7 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'sphinxdoc' +html_theme = "sphinx_rtd_theme" # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the @@ -106,7 +124,7 @@ #html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] +html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". @@ -153,7 +171,7 @@ #html_domain_indices = True # If false, no index is generated. -#html_use_index = True +html_use_index = True # If true, the index is split into individual pages for each letter. #html_split_index = False @@ -165,7 +183,7 @@ #html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True +html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the @@ -197,7 +215,7 @@ # author, documentclass [howto, manual, or own class]). latex_documents = [ ('index', 'pythonocc-examples.tex', u'pythonocc-examples Documentation', - u'Thomas Paviot and others', 'manual'), + u'Thomas Paviot', 'manual'), ] # The name of an image file (relative to this directory) to place at the top of @@ -227,7 +245,7 @@ # (source start file, name, description, authors, manual section). man_pages = [ ('index', 'pythonocc-examples', u'pythonocc-examples Documentation', - [u'Thomas Paviot and others'], 1) + [u'Thomas Paviot'], 1) ] # If true, show URL addresses after external links. @@ -241,7 +259,7 @@ # dir menu entry, description, category) texinfo_documents = [ ('index', 'pythonocc-examples', u'pythonocc-examples Documentation', - u'Thomas Paviot and others', 'pythonocc-examples', 'One line description of project.', + u'Thomas Paviot', 'pythonocc-examples', 'One line description of project.', 'Miscellaneous'), ] diff --git a/doc/examples/index.rst b/doc/examples/index.rst index c1d27f930..5b756478f 100644 --- a/doc/examples/index.rst +++ b/doc/examples/index.rst @@ -22,4 +22,3 @@ Indices and tables * :ref:`genindex` * :ref:`modindex` * :ref:`search` - diff --git a/doc/examples/intro.rst b/doc/examples/intro.rst index 19c26e9d9..c641b39c9 100644 --- a/doc/examples/intro.rst +++ b/doc/examples/intro.rst @@ -15,7 +15,7 @@ From a python prompt, type the following:: In [1]: import OCC In [2]: OCC.VERSION - Out[2]: '0.16.0' + Out[2]: '0.17' About this Document ------------------- @@ -28,4 +28,3 @@ and quickly become as autonomous as possible to dive into further details. Each subtopic is related to a python example that can be found in the /examples subfolder. - diff --git a/doc/examples_fr/conf.py b/doc/examples_fr/conf.py index 465c80023..9e8d07cee 100644 --- a/doc/examples_fr/conf.py +++ b/doc/examples_fr/conf.py @@ -14,6 +14,10 @@ import sys import os +import shlex +import sphinx +from sphinx.errors import VersionRequirementError +import sphinx_rtd_theme # 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 @@ -23,12 +27,26 @@ # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' +needs_sphinx = '1.4' +if needs_sphinx > sphinx.__display_version__: + message = 'This project needs at least Sphinx v{0!s}'.format(needs_sphinx) + raise VersionRequirementError(message) # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = [] +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.autosummary', + 'sphinx.ext.coverage', + 'sphinx.ext.graphviz', + 'sphinx.ext.doctest', + 'sphinx.ext.intersphinx', + 'sphinx.ext.todo', + 'sphinx.ext.coverage', + 'sphinx.ext.imgmath', + 'sphinx.ext.ifconfig', +] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -44,20 +62,20 @@ # General information about the project. project = u'pythonocc examples' -copyright = u'2014, Thomas Paviot and others' +copyright = u'2016, Thomas Paviot and others' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. -version = '0.16.0' +version = '0.17' # The full version, including alpha/beta/rc tags. -release = '0.16.0' +release = '0.17' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -#language = None +language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: @@ -74,11 +92,11 @@ #default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True +add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). -#add_module_names = True +add_module_names = False # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. @@ -98,7 +116,7 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'sphinxdoc' +html_theme = "sphinx_rtd_theme" # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the @@ -106,7 +124,7 @@ #html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] +html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". @@ -153,7 +171,7 @@ #html_domain_indices = True # If false, no index is generated. -#html_use_index = True +html_use_index = True # If true, the index is split into individual pages for each letter. #html_split_index = False @@ -165,7 +183,7 @@ #html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True +html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the @@ -241,7 +259,7 @@ # dir menu entry, description, category) texinfo_documents = [ ('index', 'pythonocc-examples', u'pythonocc-examples Documentation', - u'Thomas Paviot and others', 'pythonocc-examples', 'One line description of project.', + u'Thomas Paviot', 'pythonocc-examples', 'One line description of project.', 'Miscellaneous'), ] diff --git a/doc/getting_started/conf.py b/doc/getting_started/conf.py index 709dbc6a6..d7dfa2fbb 100644 --- a/doc/getting_started/conf.py +++ b/doc/getting_started/conf.py @@ -1,7 +1,7 @@ # -*- coding: utf-8 -*- # -# pythonocc-examples documentation build configuration file, created by -# sphinx-quickstart on Tue Oct 21 06:25:44 2014. +# pythonocc API documentation build configuration file, created by +# sphinx-quickstart on Wed Oct 22 05:42:56 2014. # # This file is execfile()d with the current directory set to its # containing dir. @@ -14,6 +14,10 @@ import sys import os +import shlex +import sphinx +from sphinx.errors import VersionRequirementError +import sphinx_rtd_theme # 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 @@ -23,12 +27,32 @@ # -- General configuration ------------------------------------------------ # If your documentation needs a minimal Sphinx version, state it here. -#needs_sphinx = '1.0' +needs_sphinx = '1.4' +if needs_sphinx > sphinx.__display_version__: + message = 'This project needs at least Sphinx v{0!s}'.format(needs_sphinx) + raise VersionRequirementError(message) + # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = [] +extensions = [ + 'sphinx.ext.autodoc', + 'sphinx.ext.autosummary', + 'sphinx.ext.coverage', + 'sphinx.ext.graphviz', + 'sphinx.ext.doctest', + 'sphinx.ext.intersphinx', + 'sphinx.ext.todo', + 'sphinx.ext.coverage', + 'sphinx.ext.imgmath', + 'sphinx.ext.ifconfig', +] + +intersphinx_mapping = {'python': ('http://docs.python.org/2', None), + 'numpy': ('http://docs.scipy.org/doc/numpy/', None), + 'scipy': ('http://docs.scipy.org/doc/scipy/reference/', None), + 'matplotlib': ('http://matplotlib.sourceforge.net/', None)} # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -44,20 +68,27 @@ # General information about the project. project = u'Getting started with pythonocc' -copyright = u'2014, Thomas Paviot' +copyright = u'2016, Thomas Paviot' +author = u'Thomas Paviot' + +# autoclass +autoclass_content = 'both' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the # built documents. # # The short X.Y version. -version = '0.16.0' +version = '0.17' # The full version, including alpha/beta/rc tags. -release = '0.16.0' +release = '0.17' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. -#language = None +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: @@ -74,11 +105,11 @@ #default_role = None # If true, '()' will be appended to :func: etc. cross-reference text. -#add_function_parentheses = True +add_function_parentheses = True # If true, the current module name will be prepended to all description # unit titles (such as .. function::). -#add_module_names = True +add_module_names = False # If true, sectionauthor and moduleauthor directives will be shown in the # output. They are ignored by default. @@ -91,14 +122,14 @@ #modindex_common_prefix = [] # If true, keep warnings as "system message" paragraphs in the built documents. -#keep_warnings = False +keep_warnings = False # -- 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 = 'sphinxdoc' +html_theme = "sphinx_rtd_theme" # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the @@ -106,7 +137,7 @@ #html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. -#html_theme_path = [] +html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". @@ -153,7 +184,7 @@ #html_domain_indices = True # If false, no index is generated. -#html_use_index = True +html_use_index = True # If true, the index is split into individual pages for each letter. #html_split_index = False @@ -165,7 +196,7 @@ #html_show_sphinx = True # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. -#html_show_copyright = True +html_show_copyright = True # If true, an OpenSearch description file will be output, and all pages will # contain a tag referring to it. The value of this option must be the @@ -175,28 +206,44 @@ # This is the file name suffix for HTML files (e.g. ".xhtml"). #html_file_suffix = None -# Output file base name for HTML help builder. -htmlhelp_basename = 'Getting started with pythonocc' +# Language to be used for generating the HTML full-text search index. +# Sphinx supports the following languages: +# 'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja' +# 'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr' +#html_search_language = 'en' + +# A dictionary with options for the search language support, empty by default. +# Now only 'ja' uses this config value +#html_search_options = {'type': 'default'} +# The name of a javascript file (relative to the configuration directory) that +# implements a search results scorer. If empty, the default will be used. +#html_search_scorer = 'scorer.js' + +# Output file base name for HTML help builder. +htmlhelp_basename = 'gettingstartedwithpythonocc' # -- Options for LaTeX output --------------------------------------------- latex_elements = { # The paper size ('letterpaper' or 'a4paper'). -'papersize': 'a4paper', +#'papersize': 'letterpaper', # The font size ('10pt', '11pt' or '12pt'). -'pointsize': '12pt', +#'pointsize': '10pt', # Additional stuff for the LaTeX preamble. #'preamble': '', + +# Latex figure (float) alignment +#'figure_align': 'htbp', } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - ('index', 'pythonocc-get-started.tex', u'Getting started with pythonocc', + ('index', 'getting_started.tex', u'Getting started with pythonocc', u'Thomas Paviot', 'manual'), ] @@ -226,7 +273,7 @@ # One entry per manual page. List of tuples # (source start file, name, description, authors, manual section). man_pages = [ - ('index', 'Getting started with pythonocc', u'Getting started with pythonocc', + ('index', 'pythonoccapi', u'Getting started with pythonocc', [u'Thomas Paviot'], 1) ] @@ -240,8 +287,8 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - ('index', 'Getting started with pythonocc', u'Getting started with pythonocc', - u'Thomas Paviot', 'Getting started with pythonocc', 'Build, install, 30 minutes experience.', + ('index', 'pythonoccAPI', u'Getting started with pythonocc', + u'Thomas Paviot', 'GettingStarted', '30 minutes build/install/run', 'Miscellaneous'), ] diff --git a/src/GarbageCollector.py b/src/GarbageCollector.py deleted file mode 100644 index b70021c65..000000000 --- a/src/GarbageCollector.py +++ /dev/null @@ -1,52 +0,0 @@ -##Copyright 2008-2014 Thomas Paviot (tpaviot@gmail.com) -## -##This file is part of pythonOCC. -## -##pythonOCC is free software: you can redistribute it and/or modify -##it under the terms of the GNU Lesser General Public License as published by -##the Free Software Foundation, either version 3 of the License, or -##(at your option) any later version. -## -##pythonOCC is distributed in the hope that it will be useful, -##but WITHOUT ANY WARRANTY; without even the implied warranty of -##MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -##GNU Lesser General Public License for more details. -## -##You should have received a copy of the GNU Lesser General Public License -##along with pythonOCC. If not, see . - -import warnings -warnings.warn("Deprecation Warning: do not use the GarbageCollector anymore, it is unneeded.") - - -class GarbageCollector(object): - """ DEPRECATED. Garbage collector for OCC objects - """ - def __init__(self): - pass - - def prevent_object(self, obj): - ''' DEPRECATED. Prevent an object from being deleted. This object is temporary - stored in a list to increase its refecount. - ''' - pass - - def push_context(self): - ''' DEPRECATED. Create a new context. When the push context method is called, - objects are collected in this new context. When the context is popped, - erase the content of the context. - ''' - pass - - def pop_context(self): - pass - - def collect_object(self, obj_deleted): - ''' DEPRECATED. This method is called whenever a pythonOCC instance is deleted.''' - pass - - def smart_purge(self): - # DEPRECATED. - pass - -garbage = GarbageCollector()