Skip to content

Commit

Permalink
deploy: c10dc50
Browse files Browse the repository at this point in the history
  • Loading branch information
iplitharas committed Nov 18, 2023
0 parents commit 0e947ec
Show file tree
Hide file tree
Showing 70 changed files with 8,301 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: 581a6525e50ddc774ffb160a9b79abdb
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file added .doctrees/environment.pickle
Binary file not shown.
Binary file added .doctrees/index.doctree
Binary file not shown.
Binary file added .doctrees/modules.doctree
Binary file not shown.
Binary file added .doctrees/src.benchmark.doctree
Binary file not shown.
Binary file added .doctrees/src.cli.benchmark_cmd.doctree
Binary file not shown.
Binary file added .doctrees/src.cli.compile_cmd.doctree
Binary file not shown.
Binary file added .doctrees/src.cli.doctree
Binary file not shown.
Binary file added .doctrees/src.cli.dry_run_cmd.doctree
Binary file not shown.
Binary file added .doctrees/src.cli.entrypoint.doctree
Binary file not shown.
Binary file added .doctrees/src.compiler_handler.doctree
Binary file not shown.
Binary file added .doctrees/src.doctree
Binary file not shown.
Binary file added .doctrees/src.file_handler.doctree
Binary file not shown.
Binary file added .doctrees/src.helpers.doctree
Binary file not shown.
Binary file added .doctrees/src.logging_setup.doctree
Binary file not shown.
Binary file added .doctrees/src.wrappers.doctree
Binary file not shown.
Empty file added .nojekyll
Empty file.
89 changes: 89 additions & 0 deletions _sources/index.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
.. pycompile documentation master file, created by
sphinx-quickstart on Tue Jun 27 13:08:22 2023.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to pycompile's docs!
=====================================

.. toctree::
:maxdepth: 2
:caption: Contents:

CLI

Contents
==================

* :ref:`genindex`
* :ref:`modindex`



CLI
==================
1. `compile <#compile>`__
2. `benchmark <#benchmark>`__
3. `dry run <#dry-run>`__


=================
compile
=================

.. code:: bash
pycompile -i your_python_files --clean-source --engine nuitka
By default, the `Cython <https://cython.org/>`__ is being used as the
default compiler.

For compiling the ``examples`` use the following command:

.. code:: bash
pycompile -i input_path --engine cython
which by default, deletes any temp build files and keeps the source
files.

.. code:: bash
pycompile -i input_path --engine nuitka
After the compilation the ``input`` dir will have the following
structure.

.. code:: text
examples
├── fib.py.py
├── fib.cpython-310-darwin.so
├── test_fib.py
Benchmark
~~~~~~~~~

For running a benchmark on the ``input-path`` use the following command:

.. code:: bash
pycompile benchmark -i src/examples -vvv
Dry run
~~~~~~~

.. code:: bash
pycompile dry_run -i ./src
7 changes: 7 additions & 0 deletions _sources/modules.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
src
===

.. toctree::
:maxdepth: 4

src
7 changes: 7 additions & 0 deletions _sources/src.benchmark.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
src.benchmark module
====================

.. automodule:: src.benchmark
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions _sources/src.cli.benchmark_cmd.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
src.cli.benchmark\_cmd module
=============================

.. automodule:: src.cli.benchmark_cmd
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions _sources/src.cli.compile_cmd.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
src.cli.compile\_cmd module
===========================

.. automodule:: src.cli.compile_cmd
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions _sources/src.cli.dry_run_cmd.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
src.cli.dry\_run\_cmd module
============================

.. automodule:: src.cli.dry_run_cmd
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions _sources/src.cli.entrypoint.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
src.cli.entrypoint module
=========================

.. automodule:: src.cli.entrypoint
:members:
:undoc-members:
:show-inheritance:
21 changes: 21 additions & 0 deletions _sources/src.cli.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
src.cli package
===============

Submodules
----------

.. toctree::
:maxdepth: 4

src.cli.benchmark_cmd
src.cli.compile_cmd
src.cli.dry_run_cmd
src.cli.entrypoint

Module contents
---------------

.. automodule:: src.cli
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions _sources/src.compiler_handler.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
src.compiler\_handler module
============================

.. automodule:: src.compiler_handler
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions _sources/src.file_handler.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
src.file\_handler module
========================

.. automodule:: src.file_handler
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions _sources/src.helpers.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
src.helpers module
==================

.. automodule:: src.helpers
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions _sources/src.logging_setup.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
src.logging\_setup module
=========================

.. automodule:: src.logging_setup
:members:
:undoc-members:
:show-inheritance:
23 changes: 23 additions & 0 deletions _sources/src.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
src package
===========

Submodules
----------

.. toctree::
:maxdepth: 4

src.benchmark
src.compiler_handler
src.file_handler
src.helpers
src.logging_setup
src.wrappers

Module contents
---------------

.. automodule:: src
:members:
:undoc-members:
:show-inheritance:
7 changes: 7 additions & 0 deletions _sources/src.wrappers.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
src.wrappers module
===================

.. automodule:: src.wrappers
:members:
:undoc-members:
:show-inheritance:
Loading

0 comments on commit 0e947ec

Please sign in to comment.