Actually updating docs...

ninezerozeronine · May 19, 2019 · a2b4e47 · a2b4e47
1 parent e73563a
commit a2b4e47
Show file tree

Hide file tree

Showing 13 changed files with 529 additions and 268 deletions.
diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@ This is a project to make a basic but fully functional 8 bit computer
 using 7400 series ICs.
 
 The full docs can be found on the GitHub Pages pages for this
-project: https://ninezerozeronine.github.io/eight-bit-computer/
+project: https://ninezerozeronine.github.io/eight_bit_computer/
 
 # License
 

diff --git a/docs/.doctrees/environment.pickle b/docs/.doctrees/environment.pickle
diff --git a/docs/.doctrees/language/index.doctree b/docs/.doctrees/language/index.doctree
diff --git a/docs/.doctrees/language/machine_code.doctree b/docs/.doctrees/language/machine_code.doctree
diff --git a/machine-code.csv → ...67c3f0809f4b3bd4d2124f/language_table.csv b/machine-code.csv → ...67c3f0809f4b3bd4d2124f/language_table.csv
diff --git a/docs/_sources/language/index.rst.txt b/docs/_sources/language/index.rst.txt
@@ -31,8 +31,9 @@ The language of the computer is broadly defined with the following terms:
 | Microcode Step           | A single transfer of data via the bus or action of a module occurring on a rising clock edge. The smallest, most specific level of control. An instruction is completed by doing a number of microcode steps. |
 +--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 
-See the full :download:`language table <language_table.html>` for a complete
-listing of all the machine code and operations and their arguments. The table is
+See the `language table <../_static/language_table.html>`_ (or
+:download:`download it <../_static/language_table.csv>`) for a complete listing
+of all the machine code and operations with their arguments. The table is
 sortable by clicking on the headers (but it's a little slow).
 
 .. toctree::

diff --git a/docs/_sources/language/machine_code.rst.txt b/docs/_sources/language/machine_code.rst.txt
@@ -13,8 +13,9 @@ There are 256 possible instruction bytes, most of these are occupied by the
 instruction set. They are organised using the grouping described below. This
 is very much inspired by how :ref:`james_bates` organised his machine code.
 
-See the full :download:`language table <language_table.html>` for a complete
-listing of all the machine code and operations and their arguments. The table is
+See the `language table <../_static/language_table.html>`_ (or
+:download:`download it <../_static/language_table.csv>`) for a complete listing
+of all the machine code and operations with their arguments. The table is
 sortable by clicking on the headers (but it's a little slow).
 
 Instruction Groups

diff --git a/docs/_static/language_table.csv b/docs/_static/language_table.csv
diff --git a/...6646e6bd059045fdae5ec/language_table.html → docs/_static/language_table.html b/...6646e6bd059045fdae5ec/language_table.html → docs/_static/language_table.html
@@ -38,7 +38,7 @@
   }
 </style>
 
-<table id="machine_code">
+<table id="language_table">
   <tr>
     <th onclick="sortTable(0)"><span>Decimal</span></th>
     <th onclick="sortTable(1)"><span>Binary</span></th>

diff --git a/docs/language/index.html b/docs/language/index.html
@@ -208,8 +208,9 @@
 </tr>
 </tbody>
 </table>
-<p>See the full <a class="reference download internal" download="" href="../_downloads/aea6a17e4976646e6bd059045fdae5ec/language_table.html"><code class="xref download docutils literal notranslate"><span class="pre">language</span> <span class="pre">table</span></code></a> for a complete
-listing of all the machine code and operations and their arguments. The table is
+<p>See the <a class="reference external" href="../_static/language_table.html">language table</a> (or
+<a class="reference download internal" download="" href="../_downloads/4cd40d388b67c3f0809f4b3bd4d2124f/language_table.csv"><code class="xref download docutils literal notranslate"><span class="pre">download</span> <span class="pre">it</span></code></a>) for a complete listing
+of all the machine code and operations with their arguments. The table is
 sortable by clicking on the headers (but it’s a little slow).</p>
 <div class="toctree-wrapper compound">
 <p class="caption"><span class="caption-text">Language Elements:</span></p>

diff --git a/docs/language/machine_code.html b/docs/language/machine_code.html
@@ -179,8 +179,9 @@ <h1>Machine Code<a class="headerlink" href="#machine-code" title="Permalink to t
 <p>There are 256 possible instruction bytes, most of these are occupied by the
 instruction set. They are organised using the grouping described below. This
 is very much inspired by how <a class="reference internal" href="../credits.html#james-bates"><span class="std std-ref">James Bates</span></a> organised his machine code.</p>
-<p>See the full <a class="reference download internal" download="" href="../_downloads/aea6a17e4976646e6bd059045fdae5ec/language_table.html"><code class="xref download docutils literal notranslate"><span class="pre">language</span> <span class="pre">table</span></code></a> for a complete
-listing of all the machine code and operations and their arguments. The table is
+<p>See the <a class="reference external" href="../_static/language_table.html">language table</a> (or
+<a class="reference download internal" download="" href="../_downloads/4cd40d388b67c3f0809f4b3bd4d2124f/language_table.csv"><code class="xref download docutils literal notranslate"><span class="pre">download</span> <span class="pre">it</span></code></a>) for a complete listing
+of all the machine code and operations with their arguments. The table is
 sortable by clicking on the headers (but it’s a little slow).</p>
 <div class="section" id="instruction-groups">
 <h2>Instruction Groups<a class="headerlink" href="#instruction-groups" title="Permalink to this headline">¶</a></h2>

diff --git a/docs/searchindex.js b/docs/searchindex.js
diff --git a/src/python/csv_to_html_table.py b/src/python/csv_to_html_table.py
@@ -5,7 +5,7 @@
 
 HEADER_TEMPLATE = "    <th onclick=\"sortTable({header_index})\"><span>{header}</span></th>"
 
-with open('../../machine-code.csv') as f:
+with open('../../sphinx_docs/_static/language_table.csv') as f:
     reader = csv.reader(f)
     for row_index, row in enumerate(reader):
         if row_index == 0: