Skip to content

Commit

Permalink
doc: Fix broken link and minor changes (#12)
Browse files Browse the repository at this point in the history
* doc: Fix link to constant

* doc: Move introduction before TOC

* doc: Remove section unused
  • Loading branch information
fraya authored Dec 25, 2024
1 parent 8f1e84e commit 9aa9274
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 13 deletions.
19 changes: 7 additions & 12 deletions documentation/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,6 @@
zlib
====

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

zlib
zlib-binding

This is the binding to the `Zlib <https://www.zlib.net/>`_ library
version ``1.3.1``.

Expand All @@ -20,8 +12,11 @@ The library is structured in two layers of modules:

* The module :doc:`zlib` sits on top of :doc:`zlib-binding` and offers a
more idiomatic access to the functionality.

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

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

* :ref:`genindex`
zlib
zlib-binding
2 changes: 1 addition & 1 deletion documentation/source/zlib-binding.rst
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ Deflate data-type field values

.. constant:: $z-ascii

Default to :const:`$z-text`_ for compatibility with 1.2.2 and
Default to :const:`$z-text` for compatibility with 1.2.2 and
earlier.

:type: :drm:`<integer>`
Expand Down

0 comments on commit 9aa9274

Please sign in to comment.