mirror of
https://github.com/drewcassidy/quicktex.git
synced 2024-09-13 06:37:34 +00:00
New index page and remove broken page
This commit is contained in:
parent
3a28ec690c
commit
03801e2e1b
33
docs/index.md
Normal file
33
docs/index.md
Normal file
@ -0,0 +1,33 @@
|
|||||||
|
# Welcome to Quicktex's Documentation
|
||||||
|
|
||||||
|
[![Documentation Status](https://readthedocs.org/projects/quicktex/badge/?version=latest)](https://quicktex.readthedocs.io/en/latest/?badge=latest)
|
||||||
|
[![Python Package](https://github.com/drewcassidy/quicktex/actions/workflows/python-package.yml/badge.svg)](https://github.com/drewcassidy/quicktex/actions/workflows/python-package.yml)
|
||||||
|
[![PyPI version](https://badge.fury.io/py/quicktex.svg)](https://badge.fury.io/py/quicktex)
|
||||||
|
|
||||||
|
Quicktex is a Python library for encoding, decoding, and manipulating compressed textures. It uses a backend written in
|
||||||
|
C++ for superior performance, as well as an extensive API for low-level access to the texture data. The compression
|
||||||
|
engine is based in [rgbcx](https://github.com/richgel999/bc7enc).
|
||||||
|
|
||||||
|
```{toctree}
|
||||||
|
---
|
||||||
|
maxdepth: 2
|
||||||
|
caption: Contents
|
||||||
|
---
|
||||||
|
|
||||||
|
reference/index
|
||||||
|
```
|
||||||
|
|
||||||
|
```{toctree}
|
||||||
|
---
|
||||||
|
maxdepth: 1
|
||||||
|
---
|
||||||
|
|
||||||
|
Changelog <changelog>
|
||||||
|
License <license>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Indices and tables
|
||||||
|
|
||||||
|
* {ref}`genindex`
|
||||||
|
* {ref}`modindex`
|
||||||
|
* {ref}`search`
|
@ -1,15 +0,0 @@
|
|||||||
Welcome to Quicktex's documentation!
|
|
||||||
========================================
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:maxdepth: 2
|
|
||||||
|
|
||||||
reference/index.rst
|
|
||||||
|
|
||||||
|
|
||||||
Indices and tables
|
|
||||||
==================
|
|
||||||
|
|
||||||
* :ref:`genindex`
|
|
||||||
* :ref:`modindex`
|
|
||||||
* :ref:`search`
|
|
@ -1,10 +0,0 @@
|
|||||||
.. py:currentmodule:: quicktex
|
|
||||||
|
|
||||||
Conversion
|
|
||||||
============
|
|
||||||
|
|
||||||
.. autoclass:: BlockEncoder
|
|
||||||
:members:
|
|
||||||
|
|
||||||
.. autoclass:: BlockDecoder
|
|
||||||
:members:
|
|
@ -1,10 +1,9 @@
|
|||||||
Reference
|
API Reference
|
||||||
=========
|
=============
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|
||||||
conversion.rst
|
|
||||||
dds.rst
|
dds.rst
|
||||||
image_utils.rst
|
image_utils.rst
|
||||||
formats/index.rst
|
formats/index.rst
|
||||||
|
Loading…
Reference in New Issue
Block a user