Fix sphinx warnings

Author: robtaylor

docs/source/amaranth-soc.rst

@@ -75,7 +75,7 @@
         top_path / "vendor/chipflow-lib/chipflow_lib",
         ]
 autoapi_generate_api_docs = True
-autoapi_template_dir = "_templates/autoapi"
+autoapi_template_dir = "chipflow-lib/_templates/autoapi"
 # autoapi_verbose_visibility = 2
 autoapi_keep_files = True
 autoapi_options = [
@@ -84,11 +84,14 @@
     'show-module-summary',
     'imported-members',
 ]
+autoapi_root = "chipflow-lib/autoapi"
 
 # Exclude autoapi templates and in-progress stuff
 exclude_patterns = [
     autoapi_template_dir,
-    "unfinished",
+    "chipflow-lib/unfinished",
+    "amaranth/cover.rst",
+    "amaranth-soc/cover.rst",
 ]
 
 
@@ -97,18 +100,11 @@
 }
 intersphinx_disabled_domains = ['std']
 
-exclude_patterns = [
-        'amaranth/index.rst',
-        'amaranth/cover.rst',
-        'amaranth-soc/index.rst',
-        'amaranth-soc/cover.rst',
-        ]
-
 rediraffe_redirects = {
     "simulator.rst": "amaranth/simulator.rst",
 }
 
-templates_path = ['_templates']
+templates_path = ['chipflow-lib/_templates']
 
 # -- Options for HTML output
 
@@ -159,12 +155,14 @@
     r"^https://github\.com/[^/]+/[^/]+/$",
 ]
 
+suppress_warnings = [ "ref.python" ]
 
 # Silence the warnings globally; otherwise they may fire on object destruction and crash completely
 # unrelated tests.
 import amaranth._unused
 amaranth._unused.MustUse._MustUse__silence = True
 
+
 # copy in the doc sources from our repos
 
 copy_docs(repos)

docs/source/amaranth.rst

@@ -1,7 +1,7 @@
 ChipFlow Library Documentation
 ==============================
 
-.. image:: _assets/chipflow-logo.svg
+.. image:: chipflow-lib/_assets/chipflow-logo.svg
    :width: 200px
    :class: sd-m-auto
    :name: landing-page-logo
@@ -13,16 +13,16 @@ ChipFlow IC Design Platform
 ChipFlow is an open-source platform for designing, testing, and manufacturing custom silicon.
 It provides a streamlined workflow from design to fabrication using Python and the Amaranth HDL.
 
-.. toctree::
    :maxdepth: 2
-   :caption: User Guide
 
 
 Contents
 --------
 
 .. toctree::
-   chipflow-lib
-   amaranth
-   amaranth-soc
+   :caption: User Guide
+
+   chipflow-lib/index
+   Amaranth Language and Toolchain <amaranth/index>
+   Amaranth System-on-a-Chip toolkit <amaranth-soc/index>
    support

docs/source/conf.py

@@ -28,12 +28,6 @@ dependencies = [
 requires = ["pdm-backend"]
 build-backend = "pdm.backend"
 
-[dependency-groups]
-dev = [
-    "-e amaranth@file:///${PROJECT_ROOT}/vendor/amaranth",
-    "-e amaranth_soc@file:///${PROJECT_ROOT}/vendor/amaranth-soc",
-]
-
 [tool.pdm.scripts]
 docs.cmd= "sphinx-build docs/source/ docs/build/"
 autodocs.cmd= "sphinx-autobuild docs/source/ docs/build/"