Skip to content

Commit

Permalink
Deploying to gh-pages from @ 567f514 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
fraya committed May 30, 2024
1 parent a7986eb commit 33840ac
Show file tree
Hide file tree
Showing 31 changed files with 4,355 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: 49c0a0a820643037cdb09384d6129df9
tags: 645f666f9bcd5a90fca523b33c5a78b7
Empty file added .nojekyll
Empty file.
17 changes: 17 additions & 0 deletions _sources/index.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
Welcome to Zlib's documentation!
================================

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

reference

This is the beginning of a binding to the `Zlib
<https://www.zlib.net/>`_ library.

Indices and tables
==================

* :ref:`genindex`
33 changes: 33 additions & 0 deletions _sources/reference.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
Reference
=========

.. current-library:: zlib
.. current-module:: zlib

Utility functions
-----------------

These functions are implemented on top of the basic zlib
stream-oriented functions. To simplify the interface, some default
options are assumed (compression level and memory usage).


.. function:: compress

Compress a string.

:signature: compress *string* => (compressed-string)

:parameter string: String to compress. An instance of :drm:`<string>`
:value compressed-string: An instance of :drm:`<string>`

:description:

Compress the source string into a new string. If there is a problem
in the compression process it raises an error.

:example:

.. code-block:: dylan
let compressed = compress("Hello");
Loading

0 comments on commit 33840ac

Please sign in to comment.