documentation refinement

docs/conf.py

@@ -30,6 +30,7 @@ extensions = [
     'myst_parser',
     'sphinx_rtd_theme',
     'sphinx.ext.autodoc',
+    'sphinx.ext.intersphinx',
 ]
 
 # Add any paths that contain templates here, relative to this directory.
@@ -53,6 +54,7 @@ html_theme = 'sphinx_rtd_theme'
 html_static_path = ['_static']
 
 # -- Options for Autodoc -----------------------------------------------------
+
 add_module_names = False
 autodoc_docstring_signature = True
 
@@ -60,3 +62,9 @@ autodoc_default_options = {
     'member-order': 'groupwise',
     'exclude-members': '__weakref__'
 }
+
+# -- Options for Intersphinx ------------------------------------------------
+
+# This config value contains the locations and names of other projects that
+# should be linked to in this documentation.
+intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}

docs/reference/s3tc.rst

@@ -1,8 +1,7 @@
 s3tc module
 ===========
 
-The s3tc module provides encoders and decoders for the common S3 Texture Compression formats. BC1-5 encoding is done
-internally using a modified version of rgbcx.h.
+.. automodule:: quicktex.s3tc
 
 bc1 module
 ----------

quicktex/__init__.py

@@ -1,2 +1 @@
-"""this is my docs"""
 from _quicktex import *

quicktex/s3tc/__init__.py

@@ -1 +1,5 @@
+"""
+The s3tc module provides encoders and decoders for the common S3 Texture Compression formats. BC1-5 encoding is done
+internally using a modified version of rgbcx.h.
+"""
 from _quicktex._s3tc import *