From 13411373725778b96b85d289311f83387950992d Mon Sep 17 00:00:00 2001 From: Miodrag Milanovic Date: Fri, 7 Feb 2025 12:43:20 +0100 Subject: Generate chip database HTML --- .readthedocs.yaml | 3 +++ docs/source/overview.rst | 5 +++-- icebox/icebox_html.py | 4 ++-- 3 files changed, 8 insertions(+), 4 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 19692d4..a379d85 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -4,6 +4,9 @@ build: os: ubuntu-22.04 tools: python: '3.11' + jobs: + pre_build: + - python3 icebox/icebox_html.py -3 -d docs/source/_static/bitdocs-384 sphinx: configuration: docs/source/conf.py diff --git a/docs/source/overview.rst b/docs/source/overview.rst index 307079b..43ef702 100644 --- a/docs/source/overview.rst +++ b/docs/source/overview.rst @@ -471,8 +471,9 @@ tiles. - `IO Tile Documentation `__ - `RAM Tile Documentation `__ - `The Bitstream File Format `__ -- `The iCE40 HX1K Bit Docs `__ -- `The iCE40 HX8K Bit Docs `__ +- `The iCE40 LP384 Bit Docs <_static/bitdocs-384/index.html>`__ +- `The iCE40 HX1K Bit Docs <_static/bitdocs-1k/index.html>`__ +- `The iCE40 HX8K Bit Docs <_static/bitdocs-8k/index.html>`__ - `Notes on UltraPlus features `__ The iceunpack program can be used to convert the bitstream into an ASCII diff --git a/icebox/icebox_html.py b/icebox/icebox_html.py index 3785a45..879cc1e 100755 --- a/icebox/icebox_html.py +++ b/icebox/icebox_html.py @@ -153,7 +153,7 @@ def print_index(): print("Project IceStorm – %s Overview" % chipname) print("

Project IceStorm – %s Overview

" % chipname) - print("""Project IceStorm aims at documenting the bitstream format of Lattice iCE40 FPGAs + print("""Project IceStorm aims at documenting the bitstream format of Lattice iCE40 FPGAs and providing simple tools for analyzing and creating bitstream files. This is work in progress.""") print("""

This documentation is auto-generated by icebox_html.py from IceBox.
@@ -203,7 +203,7 @@ def print_tile(tx, ty): print("Project IceStorm – %s %s Tile (%d %d)" % (chipname, tile_type, tx, ty)) print("

Project IceStorm – %s %s Tile (%d %d)

" % (chipname, tile_type, tx, ty)) - print("""Project IceStorm aims at documenting the bitstream format of Lattice iCE40 FPGAs + print("""Project IceStorm aims at documenting the bitstream format of Lattice iCE40 FPGAs and providing simple tools for analyzing and creating bitstream files. This is work in progress.""") print("""

This page describes the %s Tile (%d %d), what nets and -- cgit v1.2.3