Docs: Refactor API into multiple pages

README.md

@@ -14,6 +14,7 @@ can specify a custom database destination by passing a database url into
 
 ```python
 #!/usr/bin/env python
+"""Example for bootstrapping UNIHAN DB and print out a row."""
 import pprint
 
 from sqlalchemy.sql.expression import func
@@ -25,13 +26,15 @@ session = bootstrap.get_session()
 
 bootstrap.bootstrap_unihan(session)
 
-random_row = session.query(Unhn).order_by(
-    func.random()
-).limit(1).first()
+random_row_query = session.query(Unhn).order_by(func.random()).limit(1)
 
-pp = pprint.PrettyPrinter(indent=0)
+assert random_row_query is not None
 
-pp.pprint(random_row.to_dict())
+random_row = random_row_query.first()
+
+pprint.pprint(bootstrap.to_dict(random_row))
+
+pprint.pprint(random_row.to_dict())  # type:ignore
 ```
 
 Run:

docs/api/bootstrap.md

@@ -0,0 +1,12 @@
+# Bootstrap - `unihan_db.bootstrap`
+
+```{module} unihan_db
+
+```
+
+```{eval-rst}
+.. automodule:: unihan_db.bootstrap
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```

docs/api/importer.md

@@ -0,0 +1,12 @@
+# Importing - `unihan_db.importer`
+
+```{module} unihan_db
+
+```
+
+```{eval-rst}
+.. automodule:: unihan_db.importer
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```

docs/api/index.md

@@ -0,0 +1,22 @@
+(api)=
+
+# API
+
+```{module} unihan_db
+
+```
+
+:::{warning}
+Be careful with these! APIs are **not** covered considered stable pre-1.0. They can break or be removed between minor versions!
+
+If you need an internal API stabilized please [file an issue](https://github.com/cihai/unihan-db/issues).
+:::
+
+```{toctree}
+:caption: API
+:maxdepth: 1
+
+bootstrap
+importer
+tables
+```

docs/api/tables.md

@@ -0,0 +1,12 @@
+# Tables - `unihan_db.tables`
+
+```{module} unihan_db
+
+```
+
+```{eval-rst}
+.. automodule:: unihan_db.tables
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```

docs/index.md

@@ -9,7 +9,7 @@
 :hidden:
 
 quickstart
-api
+api/index
 ```
 
 ```{toctree}

docs/redirects.txt

@@ -0,0 +1 @@
+"api.md" "api/index.md"