docs: Generate API

Author: robtaylor

chipflow_lib/__init__.py

@@ -4,6 +4,8 @@
 import sys
 import tomli
 
+__version__ = importlib.metadata.version("chipflow_lib")
+
 
 class ChipFlowError(Exception):
     pass

docs/_static/chipflow-logo.png

@@ -33,7 +33,7 @@ The ``project_name`` is a human-readable identifier for this project. If not set
 
 The ``steps`` section allows overriding or addition to the standard steps available from `chipflow_lib`_.
 
-For example, if you want to override the standard silicon preparation step, you could derive from :ref:`SiliconStep`, add your custom functionality
+For example, if you want to override the standard silicon preparation step, you could derive from :class:`chipflow_lib.steps.silicon.SiliconStep`, add your custom functionality
 and add the following to your `chipflow.toml`, with the appropriate Python `qualified name`_ :
 
 .. code-block:: TOML

docs/_static/chipflow-logo.svg

@@ -6,6 +6,8 @@
 import sys
 sys.path.insert(0, os.path.abspath('../../chipflow_lib'))
 
+from chipflow_lib import __version__
+
 doctest_path = [os.path.abspath('..')]
 
 # -- Project information
@@ -15,34 +17,62 @@
 author = 'ChipFlow Platform Team'
 
 release = 'alpha'
-version = '0.1.0'
+version = __version__
+
+master_doc = "index"
 
 # -- General configuration
 
 extensions = [
     'sphinx.ext.duration',
     'sphinx.ext.doctest',
     'sphinx.ext.autodoc',
-    'sphinx.ext.autosummary',
     'sphinx.ext.intersphinx',
+    'autoapi.extension',
     'sphinx.ext.napoleon'
 ]
 
-html_static_path = ['_static']
-html_logo = '_static/chipflow-logo.png'
-logo_only = True
 html_theme = 'sphinx_book_theme'
+html_logo = '_static/chipflow-logo.svg'
+html_title = "ChipFlow Platform Documentation"
+
 
 html_sidebars = {
     '**': [
         'relations.html',  # needs 'show_related': True theme option to display
         'searchbox.html',
     ]
 }
+
+html_static_path = ['_static']
+
+html_theme_options = {
+    "home_page_in_toc": True,
+    "repository_url": "https://github.com/ChipFlow/chipflow-lib",
+    "repository_branch": "master",
+    "path_to_docs": "docs",
+    "use_repository_button": True,
+    "use_edit_page_button": True,
+    "use_issues_button": True,
+    "show_navbar_depth": 3,
+    # "announcement": "<b>v3.0.0</b> is now out! See the Changelog for details",
+}
+
+autodoc_typehints = 'description'
+
+autoapi_dirs = ["../chipflow_lib"]
+autoapi_options = [
+    'members',
+    'undoc-members',
+    'show-inheritance',
+    'show-module-summary',
+    'imported-members',
+]
+
 intersphinx_mapping = {
-    'python': ('https://docs.python.org/3/', None),
-    'sphinx': ('https://www.sphinx-doc.org/en/master/', None),
-    'chipflow': ('https://docs.chipflow.io/', None),
+    'py': ('https://docs.python.org/3/', None),
+    'amaranth': ('https://amaranth-lang.org/docs/amaranth/v0.5.4/', None),
+    # 'chipflow': ('https://docs.chipflow.io/', None),
 }
 intersphinx_disabled_domains = ['std']
 

docs/chipflow-toml-guide.rst

@@ -1,9 +1,15 @@
-chipflow-lib documentation
-==========================
+.. image: _static/logo-square.svg
+   :width: 200px
+   :class: sd-m-auto
+   :name: landing-page-logo
+
+
+.. rubric: ChipFlow IC Design Platform
 
 Contents
 --------
 
 .. toctree::
 
    chipflow-toml-guide
+

docs/conf.py

@@ -28,6 +28,7 @@ dependencies = [
     "python-dotenv>=1.0.1",
     "pydantic>=2.10.6",
     "sphinx-book-theme>=1.1.3",
+    "sphinx-autoapi>=3.5.0",
 ]
 
 [project.scripts]