Skip to content

Commit d0b6b65

Browse files
committed
deploy: 8d241c7
1 parent 0eae372 commit d0b6b65

6 files changed

Lines changed: 2 additions & 7 deletions

File tree

‎.doctrees/environment.pickle‎

0 Bytes
Binary file not shown.

‎.doctrees/index.doctree‎

-1.14 KB
Binary file not shown.

‎_sources/index.md.txt‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,3 @@ A Python project template with compiled Cython extensions
2424

2525
> [!NOTE]
2626
> This library was generated using [copier](https://copier.readthedocs.io/en/stable/) from the [Base Python Project Template repository](https://github.com/python-project-templates/base).
27-
28-
The examples compile Python (`_compiled.py`) and Cython (`_native.pyx`) modules with hatch-cython.
29-
See the [development guide](docs/development.md) for build and test instructions.

‎_static/searchlite-index.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
[{"u":"autoapi/index.html","t":"API Reference","x":"API Reference This page contains auto-generated API reference documentation 1. python_template_cython python_template_cython._compiled python_template_cython.tests python_template_cython.tests.test_extensions 1 Created with sphinx-autoapi"},{"u":"autoapi/python_template_cython/_compiled/index.html","t":"python_template_cython._compiled","x":"python_template_cython._compiled Functions square(\u2192 int) Module Contents python_template_cython._compiled.square(value: int) -> int"},{"u":"autoapi/python_template_cython/_compiled/index.html#functions","t":"python_template_cython._compiled","s":"Functions","x":"square(\u2192 int)"},{"u":"autoapi/python_template_cython/_compiled/index.html#module-contents","t":"python_template_cython._compiled","s":"Module Contents","x":"python_template_cython._compiled.square(value: int) -> int"},{"u":"autoapi/python_template_cython/index.html","t":"python_template_cython","x":"python_template_cython Submodules python_template_cython._compiled python_template_cython.tests Attributes __version__ Functions square(\u2192 int) Package Contents python_template_cython.square(value: int) -> int python_template_cython.__version__ = '0.1.0'"},{"u":"autoapi/python_template_cython/index.html#submodules","t":"python_template_cython","s":"Submodules","x":"python_template_cython._compiled python_template_cython.tests"},{"u":"autoapi/python_template_cython/index.html#attributes","t":"python_template_cython","s":"Attributes","x":"__version__"},{"u":"autoapi/python_template_cython/index.html#functions","t":"python_template_cython","s":"Functions","x":"square(\u2192 int)"},{"u":"autoapi/python_template_cython/index.html#package-contents","t":"python_template_cython","s":"Package Contents","x":"python_template_cython.square(value: int) -> int python_template_cython.__version__ = '0.1.0'"},{"u":"autoapi/python_template_cython/tests/index.html","t":"python_template_cython.tests","x":"python_template_cython.tests Submodules python_template_cython.tests.test_extensions"},{"u":"autoapi/python_template_cython/tests/index.html#submodules","t":"python_template_cython.tests","s":"Submodules","x":"python_template_cython.tests.test_extensions"},{"u":"autoapi/python_template_cython/tests/test_extensions/index.html","t":"python_template_cython.tests.test_extensions","x":"python_template_cython.tests.test_extensions Functions test_compiled_extension(module) test_square(value) test_add() Module Contents python_template_cython.tests.test_extensions.test_compiled_extension(module) python_template_cython.tests.test_extensions.test_square(value) python_template_cython.tests.test_extensions.test_add()"},{"u":"autoapi/python_template_cython/tests/test_extensions/index.html#functions","t":"python_template_cython.tests.test_extensions","s":"Functions","x":"test_compiled_extension(module) test_square(value) test_add()"},{"u":"autoapi/python_template_cython/tests/test_extensions/index.html#module-contents","t":"python_template_cython.tests.test_extensions","s":"Module Contents","x":"python_template_cython.tests.test_extensions.test_compiled_extension(module) python_template_cython.tests.test_extensions.test_square(value) python_template_cython.tests.test_extensions.test_add()"},{"u":"docs/development.html","t":"How to build and test extensions","x":"How to build and test extensions Install a C compiler, Python 3.11, and uv. Use Xcode Command Line Tools on macOS or Visual Studio Build Tools on Windows. uv venv --python 3.11 source .venv/bin/activate make develop make lint make checks make coverage make dist make test-dist On Windows, activate with .venv\\Scripts\\activate instead. make test-dist installs compatible wheels in fresh environments and verifies compiled imports outside the checkout. It also rebuilds each sdist into a wheel and repeats those checks. To compile another .py or .pyx module, add its path to [tool.hatch.build.targets.wheel.hooks.cython.options.files].targets in pyproject.toml, then run make develop again. Only explicitly selected modules are compiled. Keep package initialization and tests as Python sources. Run make test after changing an extension. Tests check that both example modules load native binaries. Coverage measures Python code; the compiled _compiled.py is excluded because builds do not enable Cython line tracing. For portable wheels, run make dist-py-wheel on the target platform. Linux wheel builds require Docker. Run make dist-py-sdist to build an sdist without compiling extensions. CI runs tes"},{"u":"index.html","t":"python template cython","x":"python template cython A Python project template with compiled Cython extensions Build Status codecov License PyPI Overview Note This library was generated using copier from the Base Python Project Template repository. The examples compile Python (_compiled.py) and Cython (_native.pyx) modules with hatch-cython. See the development guide for build and test instructions."},{"u":"index.html#overview","t":"python template cython","s":"Overview","x":"Note This library was generated using copier from the Base Python Project Template repository. The examples compile Python (_compiled.py) and Cython (_native.pyx) modules with hatch-cython. See the development guide for build and test instructions."}]
1+
[{"u":"autoapi/index.html","t":"API Reference","x":"API Reference This page contains auto-generated API reference documentation 1. python_template_cython python_template_cython._compiled python_template_cython.tests python_template_cython.tests.test_extensions 1 Created with sphinx-autoapi"},{"u":"autoapi/python_template_cython/_compiled/index.html","t":"python_template_cython._compiled","x":"python_template_cython._compiled Functions square(\u2192 int) Module Contents python_template_cython._compiled.square(value: int) -> int"},{"u":"autoapi/python_template_cython/_compiled/index.html#functions","t":"python_template_cython._compiled","s":"Functions","x":"square(\u2192 int)"},{"u":"autoapi/python_template_cython/_compiled/index.html#module-contents","t":"python_template_cython._compiled","s":"Module Contents","x":"python_template_cython._compiled.square(value: int) -> int"},{"u":"autoapi/python_template_cython/index.html","t":"python_template_cython","x":"python_template_cython Submodules python_template_cython._compiled python_template_cython.tests Attributes __version__ Functions square(\u2192 int) Package Contents python_template_cython.square(value: int) -> int python_template_cython.__version__ = '0.1.0'"},{"u":"autoapi/python_template_cython/index.html#submodules","t":"python_template_cython","s":"Submodules","x":"python_template_cython._compiled python_template_cython.tests"},{"u":"autoapi/python_template_cython/index.html#attributes","t":"python_template_cython","s":"Attributes","x":"__version__"},{"u":"autoapi/python_template_cython/index.html#functions","t":"python_template_cython","s":"Functions","x":"square(\u2192 int)"},{"u":"autoapi/python_template_cython/index.html#package-contents","t":"python_template_cython","s":"Package Contents","x":"python_template_cython.square(value: int) -> int python_template_cython.__version__ = '0.1.0'"},{"u":"autoapi/python_template_cython/tests/index.html","t":"python_template_cython.tests","x":"python_template_cython.tests Submodules python_template_cython.tests.test_extensions"},{"u":"autoapi/python_template_cython/tests/index.html#submodules","t":"python_template_cython.tests","s":"Submodules","x":"python_template_cython.tests.test_extensions"},{"u":"autoapi/python_template_cython/tests/test_extensions/index.html","t":"python_template_cython.tests.test_extensions","x":"python_template_cython.tests.test_extensions Functions test_compiled_extension(module) test_square(value) test_add() Module Contents python_template_cython.tests.test_extensions.test_compiled_extension(module) python_template_cython.tests.test_extensions.test_square(value) python_template_cython.tests.test_extensions.test_add()"},{"u":"autoapi/python_template_cython/tests/test_extensions/index.html#functions","t":"python_template_cython.tests.test_extensions","s":"Functions","x":"test_compiled_extension(module) test_square(value) test_add()"},{"u":"autoapi/python_template_cython/tests/test_extensions/index.html#module-contents","t":"python_template_cython.tests.test_extensions","s":"Module Contents","x":"python_template_cython.tests.test_extensions.test_compiled_extension(module) python_template_cython.tests.test_extensions.test_square(value) python_template_cython.tests.test_extensions.test_add()"},{"u":"docs/development.html","t":"How to build and test extensions","x":"How to build and test extensions Install a C compiler, Python 3.11, and uv. Use Xcode Command Line Tools on macOS or Visual Studio Build Tools on Windows. uv venv --python 3.11 source .venv/bin/activate make develop make lint make checks make coverage make dist make test-dist On Windows, activate with .venv\\Scripts\\activate instead. make test-dist installs compatible wheels in fresh environments and verifies compiled imports outside the checkout. It also rebuilds each sdist into a wheel and repeats those checks. To compile another .py or .pyx module, add its path to [tool.hatch.build.targets.wheel.hooks.cython.options.files].targets in pyproject.toml, then run make develop again. Only explicitly selected modules are compiled. Keep package initialization and tests as Python sources. Run make test after changing an extension. Tests check that both example modules load native binaries. Coverage measures Python code; the compiled _compiled.py is excluded because builds do not enable Cython line tracing. For portable wheels, run make dist-py-wheel on the target platform. Linux wheel builds require Docker. Run make dist-py-sdist to build an sdist without compiling extensions. CI runs tes"},{"u":"index.html","t":"python template cython","x":"python template cython A Python project template with compiled Cython extensions Build Status codecov License PyPI Overview Note This library was generated using copier from the Base Python Project Template repository."},{"u":"index.html#overview","t":"python template cython","s":"Overview","x":"Note This library was generated using copier from the Base Python Project Template repository."}]

‎index.html‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -263,8 +263,6 @@ <h2>Overview<a class="headerlink" href="#overview" title="Link to this heading">
263263
<p class="admonition-title">Note</p>
264264
<p>This library was generated using <a class="reference external" href="https://copier.readthedocs.io/en/stable/">copier</a> from the <a class="reference external" href="https://github.com/python-project-templates/base">Base Python Project Template repository</a>.</p>
265265
</div>
266-
<p>The examples compile Python (<code class="docutils literal notranslate"><span class="pre">_compiled.py</span></code>) and Cython (<code class="docutils literal notranslate"><span class="pre">_native.pyx</span></code>) modules with hatch-cython.
267-
See the <a class="reference internal" href="docs/development.html"><span class="std std-doc">development guide</span></a> for build and test instructions.</p>
268266
</section>
269267
</section>
270268

0 commit comments

Comments
 (0)