ByoungSooPark/cadquery
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fixed documentation

Browse Source
This commit is contained in:
Dave Cowden
2015-12-01 22:54:36 -05:00
parent b99a99d1c1
commit 0959d4bbaa
10 changed files with 38 additions and 82 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
doc/apireference.rst
View File

@ -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

27
doc/classreference.rst
View File

@ -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:

2
doc/conf.py
View File

@ -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.

22
doc/index.rst
View File

@ -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
-------------------

4
doc/installation.rst
View File

@ -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
------------------------