fixed documentation

.travis.yml

@@ -11,6 +11,7 @@ install:
   - python ./setup.py install
   - pip install coverage
   - pip install coveralls
+  - pip install Sphinx=1.3.2
   - pip install travis-sphinx
 
 script:

cadquery/__init__.py

@@ -7,8 +7,8 @@ from .freecad_impl import importers
 #these items are the common implementation
 
 #the order of these matter
-from .selectors import NearestToPointSelector,ParallelDirSelector,DirectionSelector,PerpendicularDirSelector,TypeSelector,DirectionMinMaxSelector,StringSyntaxSelector,Selector
-from .CQ import CQ,CQContext,Workplane
+from .selectors import *
+from .CQ import *
 
 
 __all__ = [

cadquery/freecad_impl/exporters.py

@@ -1,24 +1,3 @@
-"""
-    Copyright (C) 2011-2015  Parametric Products Intellectual Holdings, LLC
-
-    This file is part of CadQuery.
-
-    CadQuery 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 2.1 of the License, or (at your option) any later version.
-
-    CadQuery 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 this library; If not, see <http://www.gnu.org/licenses/>
-
-    An exporter should provide functionality to accept a shape, and return
-    a string containing the model content.
-"""
 import cadquery
 
 import FreeCAD

cadquery/freecad_impl/importers.py

@@ -1,24 +1,4 @@
-"""
-    Copyright (C) 2011-2015  Parametric Products Intellectual Holdings, LLC
 
-    This file is part of CadQuery.
-
-    CadQuery 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 2.1 of the License, or (at your option) any later version.
-
-    CadQuery 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 this library; If not, see <http://www.gnu.org/licenses/>
-
-    An exporter should provide functionality to accept a shape, and return
-    a string containing the model content.
-"""
 import cadquery
 from .shapes import Shape
 

doc/apireference.rst

@@ -16,12 +16,11 @@ This page lists  methods of these objects grouped by **functional area**
   This page lists api methods grouped by functional area.
   Use :ref:`classreference` to see methods alphabetically by class.
 
-.. module:: cadquery
 
 Initialization
 ----------------
 
-.. currentmodule:: cadquery.CQ
+.. currentmodule:: cadquery
 
 Creating new workplanes and object chains
 
@@ -39,8 +38,10 @@ Creating 2-d constructs that can be used to create 3 d features.
 
 All 2-d operations require a **Workplane** object to be created.
 
+.. currentmodule:: cadquery
+
 .. autosummary::
-	Workplane.center
+    Workplane.center
 	Workplane.lineTo
 	Workplane.line
 	Workplane.vLine
@@ -99,6 +100,11 @@ File Management and Export
     CQ.exportSvg
 
 
+.. autosummary::
+    importers.importStep
+    exporters.exportShape
+
+
 Iteration Methods
 ------------------
 
@@ -142,7 +148,7 @@ Selectors
 Objects that filter and select CAD objects. Selectors are used to select existing geometry
 as a basis for futher operations.
 
-.. currentmodule:: cadquery.selectors
+.. currentmodule:: cadquery
 
 .. autosummary::
 
@@ -159,4 +165,4 @@ as a basis for futher operations.
         SumSelector
         SubtractSelector
         InverseSelector
-        StringSyntaxSelector
+        StringSyntaxSelector

doc/classreference.rst

@@ -15,18 +15,14 @@ This page documents all of the methods and functions of the CadQuery classes, or
 Core Classes
 ---------------------
 
-.. currentmodule:: cadquery.CQ
 .. autosummary::
-
-    CQ
-    Workplane
+     CQ
+     Workplane
 
 Topological Classes
 ----------------------
 
-.. currentmodule:: cadquery.freecad_impl.shapes
 .. autosummary::
-
     Shape
     Vertex
     Edge
@@ -39,9 +35,7 @@ Topological Classes
 Geometry Classes
 ------------------
 
-.. currentmodule:: cadquery.freecad_impl.geom
 .. autosummary::
-
     Vector
     Matrix
     Plane
@@ -49,7 +43,7 @@ Geometry Classes
 Selector Classes
 ---------------------
 
-.. currentmodule:: cadquery.selectors
+
 .. autosummary::
 
     Selector
@@ -68,22 +62,9 @@ Selector Classes
     InverseSelector
     StringSyntaxSelector
 
-.. currentmodule:: cadquery
 
 Class Details
 ---------------
 
-.. autoclass:: cadquery.CQ.CQ
-   :members:
-
-.. autoclass:: cadquery.CQ.Workplane
-   :members:
-
-.. automodule:: cadquery.selectors
-   :members:
-
-.. automodule:: cadquery.freecad_impl.geom
-   :members:
-
-.. automodule:: cadquery.freecad_impl.shapes
+.. automodule:: cadquery
    :members:

doc/conf.py

@@ -81,7 +81,7 @@ exclude_patterns = ['_build']
 
 # If true, the current module name will be prepended to all description
 # unit titles (such as .. function::).
-#add_module_names = True
+add_module_names = True
 
 # If true, sectionauthor and moduleauthor directives will be shown in the
 # output. They are ignored by default.

doc/index.rst

@@ -1,7 +1,4 @@
-.. CadQuery documentation master file, created by
-   sphinx-quickstart on Sat Aug 25 21:10:53 2012.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
+
 
 CadQuery Documentation
 ===================================
@@ -17,14 +14,18 @@ CadQuery is an intuitive, easy-to-use python library for building parametric 3D
 
     * Provide a non-proprietary, plain text model format that can be edited and executed with only a web browser
 
+See CadQuery in Action
+-------------------------
+
+This `Getting Started Video <https://youtu.be/lxhBNOE7GVs>`_ will show you what CadQuery can do.
+
+
 Quick Links
--------------------
+------------------
 
-For the impatient, here's where you probably want to get started
-
-  ====================   ============================       ==========================================================   ====================
-  :ref:`quickstart`      :ref:`installation`                `CadQuery CheatSheet <_static/cadquery_cheatsheet.html>`_    :ref:`apireference`
-  ====================   ============================       ==========================================================   ====================
+  * :ref:`quickstart`
+  * `CadQuery CheatSheet <_static/cadquery_cheatsheet.html>`_
+  * :ref:`apireference`
 
 Table Of Contents
 -------------------
@@ -46,6 +47,7 @@ Table Of Contents
     roadmap.rst
 
 
+
 Indices and tables
 -------------------
 

doc/installation.rst

@@ -18,12 +18,16 @@ On Ubuntu, you can type::
         sudo apt-get install -y freecad freecad-doc
         pip install cadquery
 
+This `Unix Installation Video <http://youtu.be/InZu8jgaYCA>`_ will walk you through the installation
+
+
 Installation: Other Platforms
 ------------------------------------------
 
    1. Install FreeCAD using the appropriate installer for your platform, on `www.freecadweb.org <http://www.freecadweb.org/wiki/?title=Download>`_
    2. pip install cadquery
 
+This `Windows Installation video <https://www.youtube.com/watch?v=dWw4Y_ah-8k>`_ will walk you through the installation on Windows
 
 Test Your Installation
 ------------------------

requirements-dev.txt

@@ -0,0 +1,3 @@
+sphinx-rtd-theme==0.1.9
+travis-sphinx==1.1.0
+Sphinx==1.3.1