From c60a858c9c28b99bea270bc63bd6126fcb3ee20b Mon Sep 17 00:00:00 2001 From: Hamilton Kibbe Date: Sun, 28 Sep 2014 21:18:25 -0400 Subject: added doc folder --- doc/source/index.rst | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 doc/source/index.rst (limited to 'doc/source/index.rst') diff --git a/doc/source/index.rst b/doc/source/index.rst new file mode 100644 index 0000000..ac28b5b --- /dev/null +++ b/doc/source/index.rst @@ -0,0 +1,29 @@ +.. Gerber Tools documentation master file, created by + sphinx-quickstart on Sun Sep 28 18:16:46 2014. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to Gerber Tools's documentation! +======================================== + +Contents: + +.. toctree:: + :maxdepth: 2 + +.. automodule:: gerber.gerber + :members: + +.. automodule:: gerber.statements + :members: + +.. automodule:: gerber.utils + :members: + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + -- cgit From 0b8e2e4b8b552e90d55eabe39aefba0b5b3daef5 Mon Sep 17 00:00:00 2001 From: Hamilton Kibbe Date: Wed, 1 Oct 2014 14:39:32 -0400 Subject: added numpydoc --- doc/source/index.rst | 67 +++++++++++++++++++++++++++++----------------------- 1 file changed, 38 insertions(+), 29 deletions(-) (limited to 'doc/source/index.rst') diff --git a/doc/source/index.rst b/doc/source/index.rst index ac28b5b..a5916f7 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,29 +1,38 @@ -.. Gerber Tools documentation master file, created by - sphinx-quickstart on Sun Sep 28 18:16:46 2014. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -Welcome to Gerber Tools's documentation! -======================================== - -Contents: - -.. toctree:: - :maxdepth: 2 - -.. automodule:: gerber.gerber - :members: - -.. automodule:: gerber.statements - :members: - -.. automodule:: gerber.utils - :members: - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` - +.. Gerber Tools documentation master file, created by + sphinx-quickstart on Sun Sep 28 18:16:46 2014. + You can adapt this file completely to your liking, but it should at least + contain the root `toctree` directive. + +Welcome to Gerber Tools's documentation! +======================================== + +Contents: + +.. toctree:: + :maxdepth: 2 + +.. automodule:: gerber + :members: + +.. automodule:: gerber.gerber + :members: + +.. automodule:: gerber.excellon + :members: + +.. automodule:: gerber.cnc + :members: + +.. automodule:: gerber.statements + :members: + +.. automodule:: gerber.utils + :members: + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` + -- cgit From f2f411493ea303075d5dbdd7656c572dda61cf67 Mon Sep 17 00:00:00 2001 From: Hamilton Kibbe Date: Thu, 9 Oct 2014 22:10:28 -0400 Subject: doc update --- doc/source/index.rst | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) (limited to 'doc/source/index.rst') diff --git a/doc/source/index.rst b/doc/source/index.rst index a5916f7..763d04a 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -20,12 +20,18 @@ Contents: .. automodule:: gerber.excellon :members: -.. automodule:: gerber.cnc +.. automodule:: gerber.render.render :members: -.. automodule:: gerber.statements +.. automodule:: gerber.gerber_statements :members: - + +.. automodule:: gerber.excellon_statements + :members: + +.. automodule:: gerber.cnc + :members: + .. automodule:: gerber.utils :members: -- cgit From 62c689be172a7a06d76fd4b69c3443f3ec053765 Mon Sep 17 00:00:00 2001 From: Hamilton Kibbe Date: Sat, 11 Oct 2014 13:12:21 -0400 Subject: Doc update --- doc/source/index.rst | 29 ++++------------------------- 1 file changed, 4 insertions(+), 25 deletions(-) (limited to 'doc/source/index.rst') diff --git a/doc/source/index.rst b/doc/source/index.rst index 763d04a..aec8b48 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -3,37 +3,16 @@ You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Welcome to Gerber Tools's documentation! +Gerber-Tools! ======================================== Contents: .. toctree:: - :maxdepth: 2 - -.. automodule:: gerber - :members: - -.. automodule:: gerber.gerber - :members: - -.. automodule:: gerber.excellon - :members: - -.. automodule:: gerber.render.render - :members: - -.. automodule:: gerber.gerber_statements - :members: - -.. automodule:: gerber.excellon_statements - :members: - -.. automodule:: gerber.cnc - :members: + :maxdepth: 1 -.. automodule:: gerber.utils - :members: + intro + documentation/index Indices and tables ================== -- cgit From b488ab6af9d7925263b2d0712abfd2ba55dc96d2 Mon Sep 17 00:00:00 2001 From: Hamilton Kibbe Date: Tue, 28 Oct 2014 11:57:36 -0400 Subject: Doc update Update project name in docs --- doc/source/index.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) (limited to 'doc/source/index.rst') diff --git a/doc/source/index.rst b/doc/source/index.rst index aec8b48..309cf88 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,9 +1,9 @@ -.. Gerber Tools documentation master file, created by +.. PCB-tools documentation master file, created by sphinx-quickstart on Sun Sep 28 18:16:46 2014. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. -Gerber-Tools! +PCB-Tools ======================================== Contents: -- cgit From 29deffcf77e963ae81aec9f8cbc61b029f3052d5 Mon Sep 17 00:00:00 2001 From: Hamilton Kibbe Date: Fri, 5 Dec 2014 23:59:28 -0500 Subject: add ipc2581 primitives --- doc/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'doc/source/index.rst') diff --git a/doc/source/index.rst b/doc/source/index.rst index 309cf88..ab29738 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -11,7 +11,7 @@ Contents: .. toctree:: :maxdepth: 1 - intro + about documentation/index Indices and tables -- cgit From bc532997aecc60f5a939f9ca6ba55dd3eae27a42 Mon Sep 17 00:00:00 2001 From: Hamilton Kibbe Date: Sun, 15 Feb 2015 22:00:03 -0500 Subject: Add feature support table per #9 --- doc/source/index.rst | 1 + 1 file changed, 1 insertion(+) (limited to 'doc/source/index.rst') diff --git a/doc/source/index.rst b/doc/source/index.rst index ab29738..c96ff8a 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -12,6 +12,7 @@ Contents: :maxdepth: 1 about + features documentation/index Indices and tables -- cgit