From 03801e2e1b36cf4e6b6e52ca60dad15907f38562 Mon Sep 17 00:00:00 2001 From: Andrew Cassidy Date: Wed, 4 May 2022 22:51:40 -0700 Subject: [PATCH] New index page and remove broken page --- docs/index.md | 33 +++++++++++++++++++++++++++++++++ docs/index.rst | 15 --------------- docs/reference/conversion.rst | 10 ---------- docs/reference/index.rst | 5 ++--- 4 files changed, 35 insertions(+), 28 deletions(-) create mode 100644 docs/index.md delete mode 100644 docs/index.rst delete mode 100644 docs/reference/conversion.rst diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..6e15398 --- /dev/null +++ b/docs/index.md @@ -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 +License +``` + +## Indices and tables + +* {ref}`genindex` +* {ref}`modindex` +* {ref}`search` \ No newline at end of file diff --git a/docs/index.rst b/docs/index.rst deleted file mode 100644 index d476089..0000000 --- a/docs/index.rst +++ /dev/null @@ -1,15 +0,0 @@ -Welcome to Quicktex's documentation! -======================================== - -.. toctree:: - :maxdepth: 2 - - reference/index.rst - - -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` diff --git a/docs/reference/conversion.rst b/docs/reference/conversion.rst deleted file mode 100644 index beb01eb..0000000 --- a/docs/reference/conversion.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. py:currentmodule:: quicktex - -Conversion -============ - -.. autoclass:: BlockEncoder - :members: - -.. autoclass:: BlockDecoder - :members: diff --git a/docs/reference/index.rst b/docs/reference/index.rst index 2309f87..670fe57 100644 --- a/docs/reference/index.rst +++ b/docs/reference/index.rst @@ -1,10 +1,9 @@ -Reference -========= +API Reference +============= .. toctree:: :maxdepth: 2 - conversion.rst dds.rst image_utils.rst formats/index.rst