aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMiodrag Milanovic <mmicko@gmail.com>2025-02-07 12:43:20 +0100
committerMiodrag Milanovic <mmicko@gmail.com>2025-02-07 12:43:20 +0100
commit13411373725778b96b85d289311f83387950992d (patch)
tree4026421742a6c58963cdb2c7868aba5e628020e5
parent287f6666c88ccf8ccbd8a7e67507580705f1ee82 (diff)
Generate chip database HTML
-rw-r--r--.readthedocs.yaml3
-rw-r--r--docs/source/overview.rst5
-rwxr-xr-xicebox/icebox_html.py4
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 <io_tile.html>`__
- `RAM Tile Documentation <ram_tile.html>`__
- `The Bitstream File Format <format.html>`__
-- `The iCE40 HX1K Bit Docs <bitdocs-1k/>`__
-- `The iCE40 HX8K Bit Docs <bitdocs-8k/>`__
+- `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 <ultraplus.html>`__
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("<title>Project IceStorm &ndash; %s Overview</title>" % chipname)
print("<h1>Project IceStorm &ndash; %s Overview</h1>" % chipname)
- print("""<i><a href="http://www.clifford.at/icestorm/">Project IceStorm</a> aims at documenting the bitstream format of Lattice iCE40 FPGAs
+ print("""<i><a href="https://prjicestorm.readthedocs.io/">Project IceStorm</a> 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.</i>""")
print("""<p>This documentation is auto-generated by <tt>icebox_html.py</tt> from IceBox.<br/>
@@ -203,7 +203,7 @@ def print_tile(tx, ty):
print("<title>Project IceStorm &ndash; %s %s Tile (%d %d)</title>" % (chipname, tile_type, tx, ty))
print("<h1>Project IceStorm &ndash; %s %s Tile (%d %d)</h1>" % (chipname, tile_type, tx, ty))
- print("""<i><a href="http://www.clifford.at/icestorm/">Project IceStorm</a> aims at documenting the bitstream format of Lattice iCE40 FPGAs
+ print("""<i><a href="https://prjicestorm.readthedocs.io/">Project IceStorm</a> 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.</i>""")
print("""<p>This page describes the %s Tile (%d %d), what nets and