quickpaver 0.1.0__tar.gz

quickpaver-0.1.0/AUTHORS.rst

@@ -0,0 +1,13 @@
+=======
+Credits
+=======
+
+Development Lead
+----------------
+
+* Antoine Collet <antoine.collet5@gmail.com>
+
+Contributors
+------------
+
+None yet. Why not be the first?

quickpaver-0.1.0/CHANGELOG.rst

@@ -0,0 +1,8 @@
+==============
+Changelog
+==============
+
+0.1.0 (2026-03-14)
+------------------
+
+* First release on PyPI.

quickpaver-0.1.0/CONTRIBUTING.rst

@@ -0,0 +1,135 @@
+.. highlight:: shell
+
+============
+Contributing
+============
+
+Contributions are welcome and greatly appreciated! Every little bit helps, and credit will always be given.
+
+You can contribute in many ways:
+
+Types of Contributions
+----------------------
+
+Reporting Bugs and Defects
+~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+A defect is any variance between the actual and expected behavior. This includes bugs in the code, issues in the documentation, or problems with visualizations.
+
+Please report defects using the `GitHub Issue Tracker <https://github.com/antoinecollet5/quickpaver/issues>`_.
+When possible, include:
+
+- A clear and descriptive title
+- Steps to reproduce the issue
+- Expected vs. actual behavior
+- Relevant logs, error messages, or screenshots
+- Information about your environment (OS, Python version, quickpaver version)
+
+See the `Pull Request Guidelines`_ section for details on development best practices.
+
+Features
+~~~~~~~~
+
+If you would like to propose a new feature, please open an issue on the
+`GitHub Issue Tracker <https://github.com/antoinecollet5/quickpaver/issues>`_.
+
+Community members and maintainers will help refine and discuss your idea before implementation.
+Early discussion helps ensure that proposed features align with the project’s goals and scope.
+
+Please see the `Pull Request Guidelines`_ section for implementation details.
+
+Documentation
+~~~~~~~~~~~~~
+
+The project can always use more documentation, whether as part of the official
+quickpaver documentation, in docstrings, tutorials, or external resources such as blog posts and articles.
+
+For docstrings, please use the
+`NumPy docstring format <https://numpydoc.readthedocs.io/en/latest/format.html>`_.
+
+Working on Issues
+-----------------
+
+Once an issue is created, its progress is tracked on GitHub using
+`labels <https://github.com/antoinecollet5/quickpaver/labels>`_ and milestones.
+
+When an issue is ready for review, a **Pull Request** can be opened and linked
+to the corresponding issue.
+
+Pull Request Guidelines
+-----------------------
+
+Please submit pull requests against the **develop** branch (not the **master** branch).
+Each pull request should be self-contained and address a single issue or feature.
+
+Before submitting a pull request, please ensure that:
+
+1. **Tests**
+   - New code is fully tested.
+   - Run the test suite with coverage to identify gaps.
+
+2. **Documentation**
+   - Relevant documentation is updated.
+   - Docstrings follow the NumPy docstring format.
+   - Tutorials and user documentation are updated when necessary.
+
+3. **Continuous Integration**
+   - All CI checks pass.
+   - All pre-commit hoocks succeed.
+   - Code coverage does not decrease.
+   - Documentation builds successfully.
+
+4. **Clarity**
+   - The pull request clearly describes the changes made.
+   - The description explains how the changes address the issue.
+   - Screenshots or examples are encouraged when they improve clarity.
+
+Once submitted, maintainers will review your pull request and may request changes.
+After approval, a maintainer will merge it.
+
+Thank you very much for your contribution and for helping improve quickpaver!
+
+Setting Up quickpaver for Local Development
+--------------------------------------------
+
+Ready to contribute? Here’s how to set up `quickpaver` for local development.
+
+1. Fork the `quickpaver` repository on GitHub.
+
+2. Clone your fork locally::
+
+    $ git clone git@github.com:your_username/quickpaver.git
+    $ cd quickpaver
+
+3. Create and activate a virtual environment, then install dependencies::
+
+    $ python -m venv venv
+    $ source venv/bin/activate  # On Windows: venv\Scripts\activate
+    $ pip install -e .[all]
+
+4. Create a new branch for your work::
+
+    $ git checkout -b name-of-your-bugfix-or-feature
+
+5. Make your changes locally.
+
+6. Run linting, tests, and coverage checks against all supported python versions::
+
+    $ pre-commit run --all-files
+    $ make coverage
+    $ tox
+
+   If you worked on documentation, you can build it locally:
+
+   .. code-block:: shell
+
+      $ cd docs
+      $ make html
+
+   The built documentation will be located in ``docs/build/html``.
+
+7. Commit your changes and push your branch to GitHub::
+
+    $ git add .
+    $ git commit -m "Clear and descriptive commit message"
+    $ git push origin name-of-your-bugfix-or-feature

quickpaver-0.1.0/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2026, Antoine COLLET
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

quickpaver-0.1.0/MANIFEST.in

@@ -0,0 +1,10 @@
+include AUTHORS.rst
+include CONTRIBUTING.rst
+include CHANGELOG.rst
+include LICENSE
+include README.rst
+
+recursive-include tests *
+recursive-exclude * *.py[co]
+
+recursive-include docs *.rst conf.py Makefile make.bat

quickpaver-0.1.0/PKG-INFO

@@ -0,0 +1,227 @@
+Metadata-Version: 2.2
+Name: quickpaver
+Version: 0.1.0
+Summary: A python package providing a paving toolbox.
+Author-email: Antoine Collet <antoinecollet5@gmail.com>
+License: BSD 3-Clause License
+        
+        Copyright (c) 2026, Antoine COLLET
+        All rights reserved.
+        
+        Redistribution and use in source and binary forms, with or without
+        modification, are permitted provided that the following conditions are met:
+        
+        1. Redistributions of source code must retain the above copyright notice, this
+           list of conditions and the following disclaimer.
+        
+        2. Redistributions in binary form must reproduce the above copyright notice,
+           this list of conditions and the following disclaimer in the documentation
+           and/or other materials provided with the distribution.
+        
+        3. Neither the name of the copyright holder nor the names of its
+           contributors may be used to endorse or promote products derived from
+           this software without specific prior written permission.
+        
+        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+        
+Project-URL: Homepage, https://pypi.org/project/quickpaver/
+Project-URL: Documentation, https://quickpaver.readthedocs.io/en/latest/
+Project-URL: Repository, https://github.com/antoinecollet5/quickpaver
+Project-URL: Issues, https://github.com/antoinecollet5/quickpaver/issues
+Project-URL: Changelog, https://github.com/antoinecollet5/quickpaver/blob/master/CHANGELOG.rst
+Keywords: Paving,Tiling,Triangle,Hexagon,Grid,Rectilinear
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.10
+Description-Content-Type: text/x-rst
+License-File: LICENSE
+License-File: AUTHORS.rst
+Requires-Dist: numpy>=1.2
+Requires-Dist: shapely>=2.1
+Requires-Dist: scipy>=1.10
+Provides-Extra: all
+Requires-Dist: quickpaver[docs,examples,install,lint,tests]; extra == "all"
+Provides-Extra: docs
+Requires-Dist: quickpaver[examples]; extra == "docs"
+Requires-Dist: sphinx<9; extra == "docs"
+Requires-Dist: nbsphinx; extra == "docs"
+Requires-Dist: nbsphinx-link>=1.3.1; extra == "docs"
+Requires-Dist: jupyter_sphinx>=0.3.2; extra == "docs"
+Requires-Dist: sphinx-jsonschema>=1.15; extra == "docs"
+Requires-Dist: pygments>=2.11.1; extra == "docs"
+Requires-Dist: pydata-sphinx-theme; extra == "docs"
+Requires-Dist: sphinxcontrib-bibtex; extra == "docs"
+Requires-Dist: sphinx_math_dollar; extra == "docs"
+Requires-Dist: jupytext; extra == "docs"
+Provides-Extra: tests
+Requires-Dist: twine==1.14.0; extra == "tests"
+Requires-Dist: pytest; extra == "tests"
+Requires-Dist: pytest-runner; extra == "tests"
+Requires-Dist: pytest-cov; extra == "tests"
+Requires-Dist: pytest-cookies; extra == "tests"
+Requires-Dist: coverage; extra == "tests"
+Provides-Extra: examples
+Requires-Dist: matplotlib; extra == "examples"
+Requires-Dist: marimo; extra == "examples"
+Requires-Dist: nested_grid_plotter>=2.1.0; extra == "examples"
+Provides-Extra: scikit-sparse-old
+Requires-Dist: scikit-sparse<0.5.0; extra == "scikit-sparse-old"
+Provides-Extra: lint
+Requires-Dist: pre-commit; extra == "lint"
+Requires-Dist: codespell>=2.1.0; extra == "lint"
+Requires-Dist: ruff; extra == "lint"
+Requires-Dist: ty; extra == "lint"
+Provides-Extra: install
+Requires-Dist: pip; extra == "install"
+Requires-Dist: wheel; extra == "install"
+
+==========
+quickpaver
+==========
+
+|License| |Stars| |Python| |PyPI| |Downloads| |Build Status| |Documentation Status| |Coverage| |Codacy| |Precommit: enabled| |Ruff| |ty|
+
+🐍 A python package providing a tiling/paving toolbox.
+
+**The complete and up to date documentation can be found here**: https://quickpaver.readthedocs.io.
+
+===============
+🎯 Motivations
+===============
+
+Designing paving layouts (aka tiling) often requires repetitive geometric calculations and careful programming to ensure that patterns and dimensions are correct. Keeping track of tiles adjacency is not trivial either and performing these tasks manually can be time-consuming and prone to errors, especially when exploring multiple design configurations or working with complex layouts.
+
+This package aims to simplify and automate the generation of paving layouts by providing a programmatic way to create and manipulate classic paving patterns.
+
+The implementation relies on `Shapely <https://shapely.readthedocs.io/en/stable/>`_ for geometric operations and leverages the `GEOS <https://libgeos.org/>`_ engine’s vectorization capabilities. This allows many geometric computations to be performed efficiently, enabling the generation and processing of large numbers of paving elements with good performance. As a result, the package provides both flexibility and speed, making it suitable for practical design tasks as well as research and experimentation.
+
+===============
+🚀 Quick start
+===============
+
+To install `quickpaver`, the easiest way is through `pip`:
+
+.. code-block::
+
+    pip install quickpaver
+
+Or alternatively using `conda`
+
+.. code-block::
+
+    conda install quickpaver
+
+You might also clone the repository and install from source
+
+.. code-block::
+
+    pip install -e .
+
+Once the installation is done, `quickpaver` is straighforward to use and proposes...
+
+🏗️ Complete example with supporting paper coming Q1 2026.
+
+===========
+🔑 License
+===========
+
+This project is released under the **BSD 3-Clause License**.
+
+Copyright (c) 2026, Antoine COLLET. All rights reserved.
+
+For more details, see the `LICENSE <https://github.com/antoinecollet5/quickpaver/blob/master/LICENSE>`_ file included in this repository.
+
+==============
+⚠️ Disclaimer
+==============
+
+This software is provided "as is", without warranty of any kind, express or implied,
+including but not limited to the warranties of merchantability, fitness for a particular purpose,
+or non-infringement. In no event shall the authors or copyright holders be liable for
+any claim, damages, or other liability, whether in an action of contract, tort,
+or otherwise, arising from, out of, or in connection with the software or the use
+or other dealings in the software.
+
+By using this software, you agree to accept full responsibility for any consequences,
+and you waive any claims against the authors or contributors.
+
+==========
+📧 Contact
+==========
+
+For questions, suggestions, or contributions, you can reach out via:
+
+- Email: antoinecollet5@gmail.com
+- GitHub: https://github.com/antoinecollet5/quickpaver
+
+We welcome contributions!
+
+=============
+📚 References
+=============
+
+TODO
+
+* Free software: SPDX-License-Identifier: BSD-3-Clause
+
+.. |License| image:: https://img.shields.io/badge/License-BSD_3--Clause-blue.svg
+    :target: https://github.com/antoinecollet5/quickpaver/blob/master/LICENSE
+
+.. |Stars| image:: https://img.shields.io/github/stars/antoinecollet5/quickpaver.svg?style=social&label=Star&maxAge=2592000
+    :target: https://github.com/antoinecollet5/quickpaver/stargazers
+    :alt: Stars
+
+.. |Python| image:: https://img.shields.io/pypi/pyversions/quickpaver.svg
+    :target: https://pypi.org/pypi/quickpaver
+    :alt: Python
+
+.. |PyPI| image:: https://img.shields.io/pypi/v/quickpaver.svg
+    :target: https://pypi.org/pypi/quickpaver
+    :alt: PyPI
+
+.. |Downloads| image:: https://static.pepy.tech/badge/quickpaver
+    :target: https://pepy.tech/project/quickpaver
+    :alt: Downoads
+
+.. |Build Status| image:: https://github.com/antoinecollet5/quickpaver/actions/workflows/main.yml/badge.svg
+    :target: https://github.com/antoinecollet5/quickpaver/actions/workflows/main.yml
+    :alt: Build Status
+
+.. |Documentation Status| image:: https://readthedocs.org/projects/quickpaver/badge/?version=latest
+    :target: https://quickpaver.readthedocs.io/en/latest/?badge=latest
+    :alt: Documentation Status
+
+.. |Coverage| image:: https://codecov.io/gh/antoinecollet5/quickpaver/graph/badge.svg?token=8lE90wylXL
+    :target: https://codecov.io/gh/antoinecollet5/quickpaver
+    :alt: Coverage
+
+.. |Codacy| image:: https://app.codacy.com/project/badge/Grade/19adca492f0f4d36872644343bd4eb36
+    :target: https://app.codacy.com/gh/antoinecollet5/quickpaver/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade
+    :alt: codacy
+
+.. |Precommit: enabled| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit
+   :target: https://github.com/pre-commit/pre-commit
+
+.. |Ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+    :target: https://github.com/astral-sh/ruff
+    :alt: Ruff
+
+.. |ty| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ty/main/assets/badge/v0.json
+    :target: https://github.com/astral-sh/ty
+    :alt: Checked with ty

quickpaver-0.1.0/README.rst

@@ -0,0 +1,134 @@
+==========
+quickpaver
+==========
+
+|License| |Stars| |Python| |PyPI| |Downloads| |Build Status| |Documentation Status| |Coverage| |Codacy| |Precommit: enabled| |Ruff| |ty|
+
+🐍 A python package providing a tiling/paving toolbox.
+
+**The complete and up to date documentation can be found here**: https://quickpaver.readthedocs.io.
+
+===============
+🎯 Motivations
+===============
+
+Designing paving layouts (aka tiling) often requires repetitive geometric calculations and careful programming to ensure that patterns and dimensions are correct. Keeping track of tiles adjacency is not trivial either and performing these tasks manually can be time-consuming and prone to errors, especially when exploring multiple design configurations or working with complex layouts.
+
+This package aims to simplify and automate the generation of paving layouts by providing a programmatic way to create and manipulate classic paving patterns.
+
+The implementation relies on `Shapely <https://shapely.readthedocs.io/en/stable/>`_ for geometric operations and leverages the `GEOS <https://libgeos.org/>`_ engine’s vectorization capabilities. This allows many geometric computations to be performed efficiently, enabling the generation and processing of large numbers of paving elements with good performance. As a result, the package provides both flexibility and speed, making it suitable for practical design tasks as well as research and experimentation.
+
+===============
+🚀 Quick start
+===============
+
+To install `quickpaver`, the easiest way is through `pip`:
+
+.. code-block::
+
+    pip install quickpaver
+
+Or alternatively using `conda`
+
+.. code-block::
+
+    conda install quickpaver
+
+You might also clone the repository and install from source
+
+.. code-block::
+
+    pip install -e .
+
+Once the installation is done, `quickpaver` is straighforward to use and proposes...
+
+🏗️ Complete example with supporting paper coming Q1 2026.
+
+===========
+🔑 License
+===========
+
+This project is released under the **BSD 3-Clause License**.
+
+Copyright (c) 2026, Antoine COLLET. All rights reserved.
+
+For more details, see the `LICENSE <https://github.com/antoinecollet5/quickpaver/blob/master/LICENSE>`_ file included in this repository.
+
+==============
+⚠️ Disclaimer
+==============
+
+This software is provided "as is", without warranty of any kind, express or implied,
+including but not limited to the warranties of merchantability, fitness for a particular purpose,
+or non-infringement. In no event shall the authors or copyright holders be liable for
+any claim, damages, or other liability, whether in an action of contract, tort,
+or otherwise, arising from, out of, or in connection with the software or the use
+or other dealings in the software.
+
+By using this software, you agree to accept full responsibility for any consequences,
+and you waive any claims against the authors or contributors.
+
+==========
+📧 Contact
+==========
+
+For questions, suggestions, or contributions, you can reach out via:
+
+- Email: antoinecollet5@gmail.com
+- GitHub: https://github.com/antoinecollet5/quickpaver
+
+We welcome contributions!
+
+=============
+📚 References
+=============
+
+TODO
+
+* Free software: SPDX-License-Identifier: BSD-3-Clause
+
+.. |License| image:: https://img.shields.io/badge/License-BSD_3--Clause-blue.svg
+    :target: https://github.com/antoinecollet5/quickpaver/blob/master/LICENSE
+
+.. |Stars| image:: https://img.shields.io/github/stars/antoinecollet5/quickpaver.svg?style=social&label=Star&maxAge=2592000
+    :target: https://github.com/antoinecollet5/quickpaver/stargazers
+    :alt: Stars
+
+.. |Python| image:: https://img.shields.io/pypi/pyversions/quickpaver.svg
+    :target: https://pypi.org/pypi/quickpaver
+    :alt: Python
+
+.. |PyPI| image:: https://img.shields.io/pypi/v/quickpaver.svg
+    :target: https://pypi.org/pypi/quickpaver
+    :alt: PyPI
+
+.. |Downloads| image:: https://static.pepy.tech/badge/quickpaver
+    :target: https://pepy.tech/project/quickpaver
+    :alt: Downoads
+
+.. |Build Status| image:: https://github.com/antoinecollet5/quickpaver/actions/workflows/main.yml/badge.svg
+    :target: https://github.com/antoinecollet5/quickpaver/actions/workflows/main.yml
+    :alt: Build Status
+
+.. |Documentation Status| image:: https://readthedocs.org/projects/quickpaver/badge/?version=latest
+    :target: https://quickpaver.readthedocs.io/en/latest/?badge=latest
+    :alt: Documentation Status
+
+.. |Coverage| image:: https://codecov.io/gh/antoinecollet5/quickpaver/graph/badge.svg?token=8lE90wylXL
+    :target: https://codecov.io/gh/antoinecollet5/quickpaver
+    :alt: Coverage
+
+.. |Codacy| image:: https://app.codacy.com/project/badge/Grade/19adca492f0f4d36872644343bd4eb36
+    :target: https://app.codacy.com/gh/antoinecollet5/quickpaver/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade
+    :alt: codacy
+
+.. |Precommit: enabled| image:: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit
+   :target: https://github.com/pre-commit/pre-commit
+
+.. |Ruff| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json
+    :target: https://github.com/astral-sh/ruff
+    :alt: Ruff
+
+.. |ty| image:: https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ty/main/assets/badge/v0.json
+    :target: https://github.com/astral-sh/ty
+    :alt: Checked with ty

quickpaver-0.1.0/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = python -msphinx
+SPHINXPROJ    = quickpaver
+SOURCEDIR     = sources
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

quickpaver-0.1.0/docs/make.bat

@@ -0,0 +1,36 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=python -msphinx
+)
+set SOURCEDIR=sources
+set BUILDDIR=build
+set SPHINXPROJ=quickpaver
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The Sphinx module was not found. Make sure you have Sphinx installed,
+	echo.then set the SPHINXBUILD environment variable to point to the full
+	echo.path of the 'sphinx-build' executable. Alternatively you may add the
+	echo.Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:end
+popd

quickpaver-0.1.0/docs/sources/_autosummary/generated/quickpaver.PolygonType.HEXAGON.rst

@@ -0,0 +1,12 @@
+..
+   Template for the html base rendering
+
+   Modified from
+   https://github.com/sphinx-doc/sphinx/tree/master/sphinx/ext/autosummary/templates/autosummary/base.rst
+
+quickpaver.PolygonType.HEXAGON
+==============================
+
+.. currentmodule:: quickpaver
+
+.. autoattribute:: PolygonType.HEXAGON

quickpaver-0.1.0/docs/sources/_autosummary/generated/quickpaver.PolygonType.RECTANGLE.rst

@@ -0,0 +1,12 @@
+..
+   Template for the html base rendering
+
+   Modified from
+   https://github.com/sphinx-doc/sphinx/tree/master/sphinx/ext/autosummary/templates/autosummary/base.rst
+
+quickpaver.PolygonType.RECTANGLE
+================================
+
+.. currentmodule:: quickpaver
+
+.. autoattribute:: PolygonType.RECTANGLE

quickpaver-0.1.0/docs/sources/_autosummary/generated/quickpaver.PolygonType.TRIANGLE.rst

@@ -0,0 +1,12 @@
+..
+   Template for the html base rendering
+
+   Modified from
+   https://github.com/sphinx-doc/sphinx/tree/master/sphinx/ext/autosummary/templates/autosummary/base.rst
+
+quickpaver.PolygonType.TRIANGLE
+===============================
+
+.. currentmodule:: quickpaver
+
+.. autoattribute:: PolygonType.TRIANGLE

quickpaver-0.1.0/docs/sources/_autosummary/generated/quickpaver.PolygonType.capitalize.rst

@@ -0,0 +1,12 @@
+..
+   Template for the html base rendering
+
+   Modified from
+   https://github.com/sphinx-doc/sphinx/tree/master/sphinx/ext/autosummary/templates/autosummary/base.rst
+
+quickpaver.PolygonType.capitalize
+=================================
+
+.. currentmodule:: quickpaver
+
+.. automethod:: PolygonType.capitalize